CIndex.cpp revision 1aee05d08b2184acadeb36de300e216390780d6c
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 "CXTranslationUnit.h"
18#include "CXString.h"
19#include "CXType.h"
20#include "CXSourceLocation.h"
21#include "CIndexDiagnostic.h"
22
23#include "clang/Basic/Version.h"
24
25#include "clang/AST/DeclVisitor.h"
26#include "clang/AST/StmtVisitor.h"
27#include "clang/AST/TypeLocVisitor.h"
28#include "clang/Basic/Diagnostic.h"
29#include "clang/Frontend/ASTUnit.h"
30#include "clang/Frontend/CompilerInstance.h"
31#include "clang/Frontend/FrontendDiagnostic.h"
32#include "clang/Lex/Lexer.h"
33#include "clang/Lex/PreprocessingRecord.h"
34#include "clang/Lex/Preprocessor.h"
35#include "llvm/ADT/STLExtras.h"
36#include "llvm/ADT/Optional.h"
37#include "clang/Analysis/Support/SaveAndRestore.h"
38#include "llvm/Support/CrashRecoveryContext.h"
39#include "llvm/Support/PrettyStackTrace.h"
40#include "llvm/Support/MemoryBuffer.h"
41#include "llvm/Support/raw_ostream.h"
42#include "llvm/Support/Timer.h"
43#include "llvm/Support/Mutex.h"
44#include "llvm/Support/Program.h"
45#include "llvm/Support/Signals.h"
46#include "llvm/Support/Threading.h"
47#include "llvm/Support/Compiler.h"
48
49using namespace clang;
50using namespace clang::cxcursor;
51using namespace clang::cxstring;
52
53static CXTranslationUnit MakeCXTranslationUnit(ASTUnit *TU) {
54  if (!TU)
55    return 0;
56  CXTranslationUnit D = new CXTranslationUnitImpl();
57  D->TUData = TU;
58  D->StringPool = createCXStringPool();
59  return D;
60}
61
62/// \brief The result of comparing two source ranges.
63enum RangeComparisonResult {
64  /// \brief Either the ranges overlap or one of the ranges is invalid.
65  RangeOverlap,
66
67  /// \brief The first range ends before the second range starts.
68  RangeBefore,
69
70  /// \brief The first range starts after the second range ends.
71  RangeAfter
72};
73
74/// \brief Compare two source ranges to determine their relative position in
75/// the translation unit.
76static RangeComparisonResult RangeCompare(SourceManager &SM,
77                                          SourceRange R1,
78                                          SourceRange R2) {
79  assert(R1.isValid() && "First range is invalid?");
80  assert(R2.isValid() && "Second range is invalid?");
81  if (R1.getEnd() != R2.getBegin() &&
82      SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
83    return RangeBefore;
84  if (R2.getEnd() != R1.getBegin() &&
85      SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin()))
86    return RangeAfter;
87  return RangeOverlap;
88}
89
90/// \brief Determine if a source location falls within, before, or after a
91///   a given source range.
92static RangeComparisonResult LocationCompare(SourceManager &SM,
93                                             SourceLocation L, SourceRange R) {
94  assert(R.isValid() && "First range is invalid?");
95  assert(L.isValid() && "Second range is invalid?");
96  if (L == R.getBegin() || L == R.getEnd())
97    return RangeOverlap;
98  if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
99    return RangeBefore;
100  if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
101    return RangeAfter;
102  return RangeOverlap;
103}
104
105/// \brief Translate a Clang source range into a CIndex source range.
106///
107/// Clang internally represents ranges where the end location points to the
108/// start of the token at the end. However, for external clients it is more
109/// useful to have a CXSourceRange be a proper half-open interval. This routine
110/// does the appropriate translation.
111CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
112                                          const LangOptions &LangOpts,
113                                          const CharSourceRange &R) {
114  // We want the last character in this location, so we will adjust the
115  // location accordingly.
116  SourceLocation EndLoc = R.getEnd();
117  if (EndLoc.isValid() && EndLoc.isMacroID())
118    EndLoc = SM.getSpellingLoc(EndLoc);
119  if (R.isTokenRange() && !EndLoc.isInvalid() && EndLoc.isFileID()) {
120    unsigned Length = Lexer::MeasureTokenLength(EndLoc, SM, LangOpts);
121    EndLoc = EndLoc.getFileLocWithOffset(Length);
122  }
123
124  CXSourceRange Result = { { (void *)&SM, (void *)&LangOpts },
125                           R.getBegin().getRawEncoding(),
126                           EndLoc.getRawEncoding() };
127  return Result;
128}
129
130//===----------------------------------------------------------------------===//
131// Cursor visitor.
132//===----------------------------------------------------------------------===//
133
134namespace {
135
136class VisitorJob {
137public:
138  enum Kind { DeclVisitKind, StmtVisitKind, MemberExprPartsKind,
139              TypeLocVisitKind, OverloadExprPartsKind,
140              DeclRefExprPartsKind, LabelRefVisitKind,
141              ExplicitTemplateArgsVisitKind,
142              NestedNameSpecifierVisitKind,
143              DeclarationNameInfoVisitKind,
144              MemberRefVisitKind };
145protected:
146  void *data[3];
147  CXCursor parent;
148  Kind K;
149  VisitorJob(CXCursor C, Kind k, void *d1, void *d2 = 0, void *d3 = 0)
150    : parent(C), K(k) {
151    data[0] = d1;
152    data[1] = d2;
153    data[2] = d3;
154  }
155public:
156  Kind getKind() const { return K; }
157  const CXCursor &getParent() const { return parent; }
158  static bool classof(VisitorJob *VJ) { return true; }
159};
160
161typedef llvm::SmallVector<VisitorJob, 10> VisitorWorkList;
162
163// Cursor visitor.
164class CursorVisitor : public DeclVisitor<CursorVisitor, bool>,
165                      public TypeLocVisitor<CursorVisitor, bool>
166{
167  /// \brief The translation unit we are traversing.
168  CXTranslationUnit TU;
169  ASTUnit *AU;
170
171  /// \brief The parent cursor whose children we are traversing.
172  CXCursor Parent;
173
174  /// \brief The declaration that serves at the parent of any statement or
175  /// expression nodes.
176  Decl *StmtParent;
177
178  /// \brief The visitor function.
179  CXCursorVisitor Visitor;
180
181  /// \brief The opaque client data, to be passed along to the visitor.
182  CXClientData ClientData;
183
184  // MaxPCHLevel - the maximum PCH level of declarations that we will pass on
185  // to the visitor. Declarations with a PCH level greater than this value will
186  // be suppressed.
187  unsigned MaxPCHLevel;
188
189  /// \brief When valid, a source range to which the cursor should restrict
190  /// its search.
191  SourceRange RegionOfInterest;
192
193  // FIXME: Eventually remove.  This part of a hack to support proper
194  // iteration over all Decls contained lexically within an ObjC container.
195  DeclContext::decl_iterator *DI_current;
196  DeclContext::decl_iterator DE_current;
197
198  // Cache of pre-allocated worklists for data-recursion walk of Stmts.
199  llvm::SmallVector<VisitorWorkList*, 5> WorkListFreeList;
200  llvm::SmallVector<VisitorWorkList*, 5> WorkListCache;
201
202  using DeclVisitor<CursorVisitor, bool>::Visit;
203  using TypeLocVisitor<CursorVisitor, bool>::Visit;
204
205  /// \brief Determine whether this particular source range comes before, comes
206  /// after, or overlaps the region of interest.
207  ///
208  /// \param R a half-open source range retrieved from the abstract syntax tree.
209  RangeComparisonResult CompareRegionOfInterest(SourceRange R);
210
211  class SetParentRAII {
212    CXCursor &Parent;
213    Decl *&StmtParent;
214    CXCursor OldParent;
215
216  public:
217    SetParentRAII(CXCursor &Parent, Decl *&StmtParent, CXCursor NewParent)
218      : Parent(Parent), StmtParent(StmtParent), OldParent(Parent)
219    {
220      Parent = NewParent;
221      if (clang_isDeclaration(Parent.kind))
222        StmtParent = getCursorDecl(Parent);
223    }
224
225    ~SetParentRAII() {
226      Parent = OldParent;
227      if (clang_isDeclaration(Parent.kind))
228        StmtParent = getCursorDecl(Parent);
229    }
230  };
231
232public:
233  CursorVisitor(CXTranslationUnit TU, CXCursorVisitor Visitor,
234                CXClientData ClientData,
235                unsigned MaxPCHLevel,
236                SourceRange RegionOfInterest = SourceRange())
237    : TU(TU), AU(static_cast<ASTUnit*>(TU->TUData)),
238      Visitor(Visitor), ClientData(ClientData),
239      MaxPCHLevel(MaxPCHLevel), RegionOfInterest(RegionOfInterest),
240      DI_current(0)
241  {
242    Parent.kind = CXCursor_NoDeclFound;
243    Parent.data[0] = 0;
244    Parent.data[1] = 0;
245    Parent.data[2] = 0;
246    StmtParent = 0;
247  }
248
249  ~CursorVisitor() {
250    // Free the pre-allocated worklists for data-recursion.
251    for (llvm::SmallVectorImpl<VisitorWorkList*>::iterator
252          I = WorkListCache.begin(), E = WorkListCache.end(); I != E; ++I) {
253      delete *I;
254    }
255  }
256
257  ASTUnit *getASTUnit() const { return static_cast<ASTUnit*>(TU->TUData); }
258  CXTranslationUnit getTU() const { return TU; }
259
260  bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false);
261
262  std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
263    getPreprocessedEntities();
264
265  bool VisitChildren(CXCursor Parent);
266
267  // Declaration visitors
268  bool VisitAttributes(Decl *D);
269  bool VisitBlockDecl(BlockDecl *B);
270  bool VisitCXXRecordDecl(CXXRecordDecl *D);
271  llvm::Optional<bool> shouldVisitCursor(CXCursor C);
272  bool VisitDeclContext(DeclContext *DC);
273  bool VisitTranslationUnitDecl(TranslationUnitDecl *D);
274  bool VisitTypedefDecl(TypedefDecl *D);
275  bool VisitTagDecl(TagDecl *D);
276  bool VisitClassTemplateSpecializationDecl(ClassTemplateSpecializationDecl *D);
277  bool VisitClassTemplatePartialSpecializationDecl(
278                                     ClassTemplatePartialSpecializationDecl *D);
279  bool VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D);
280  bool VisitEnumConstantDecl(EnumConstantDecl *D);
281  bool VisitDeclaratorDecl(DeclaratorDecl *DD);
282  bool VisitFunctionDecl(FunctionDecl *ND);
283  bool VisitFieldDecl(FieldDecl *D);
284  bool VisitVarDecl(VarDecl *);
285  bool VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D);
286  bool VisitFunctionTemplateDecl(FunctionTemplateDecl *D);
287  bool VisitClassTemplateDecl(ClassTemplateDecl *D);
288  bool VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D);
289  bool VisitObjCMethodDecl(ObjCMethodDecl *ND);
290  bool VisitObjCContainerDecl(ObjCContainerDecl *D);
291  bool VisitObjCCategoryDecl(ObjCCategoryDecl *ND);
292  bool VisitObjCProtocolDecl(ObjCProtocolDecl *PID);
293  bool VisitObjCPropertyDecl(ObjCPropertyDecl *PD);
294  bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
295  bool VisitObjCImplDecl(ObjCImplDecl *D);
296  bool VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
297  bool VisitObjCImplementationDecl(ObjCImplementationDecl *D);
298  // FIXME: ObjCCompatibleAliasDecl requires aliased-class locations.
299  bool VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D);
300  bool VisitObjCClassDecl(ObjCClassDecl *D);
301  bool VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PD);
302  bool VisitLinkageSpecDecl(LinkageSpecDecl *D);
303  bool VisitNamespaceDecl(NamespaceDecl *D);
304  bool VisitNamespaceAliasDecl(NamespaceAliasDecl *D);
305  bool VisitUsingDirectiveDecl(UsingDirectiveDecl *D);
306  bool VisitUsingDecl(UsingDecl *D);
307  bool VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D);
308  bool VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D);
309
310  // Name visitor
311  bool VisitDeclarationNameInfo(DeclarationNameInfo Name);
312  bool VisitNestedNameSpecifier(NestedNameSpecifier *NNS, SourceRange Range);
313
314  // Template visitors
315  bool VisitTemplateParameters(const TemplateParameterList *Params);
316  bool VisitTemplateName(TemplateName Name, SourceLocation Loc);
317  bool VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL);
318
319  // Type visitors
320  bool VisitQualifiedTypeLoc(QualifiedTypeLoc TL);
321  bool VisitBuiltinTypeLoc(BuiltinTypeLoc TL);
322  bool VisitTypedefTypeLoc(TypedefTypeLoc TL);
323  bool VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL);
324  bool VisitTagTypeLoc(TagTypeLoc TL);
325  bool VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL);
326  bool VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL);
327  bool VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL);
328  bool VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL);
329  bool VisitParenTypeLoc(ParenTypeLoc TL);
330  bool VisitPointerTypeLoc(PointerTypeLoc TL);
331  bool VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL);
332  bool VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL);
333  bool VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL);
334  bool VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL);
335  bool VisitFunctionTypeLoc(FunctionTypeLoc TL, bool SkipResultType = false);
336  bool VisitArrayTypeLoc(ArrayTypeLoc TL);
337  bool VisitTemplateSpecializationTypeLoc(TemplateSpecializationTypeLoc TL);
338  // FIXME: Implement visitors here when the unimplemented TypeLocs get
339  // implemented
340  bool VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL);
341  bool VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL);
342  bool VisitTypeOfTypeLoc(TypeOfTypeLoc TL);
343
344  // Data-recursive visitor functions.
345  bool IsInRegionOfInterest(CXCursor C);
346  bool RunVisitorWorkList(VisitorWorkList &WL);
347  void EnqueueWorkList(VisitorWorkList &WL, Stmt *S);
348  LLVM_ATTRIBUTE_NOINLINE bool Visit(Stmt *S);
349};
350
351} // end anonymous namespace
352
353static SourceRange getRawCursorExtent(CXCursor C);
354static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr);
355
356
357RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
358  return RangeCompare(AU->getSourceManager(), R, RegionOfInterest);
359}
360
361/// \brief Visit the given cursor and, if requested by the visitor,
362/// its children.
363///
364/// \param Cursor the cursor to visit.
365///
366/// \param CheckRegionOfInterest if true, then the caller already checked that
367/// this cursor is within the region of interest.
368///
369/// \returns true if the visitation should be aborted, false if it
370/// should continue.
371bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
372  if (clang_isInvalid(Cursor.kind))
373    return false;
374
375  if (clang_isDeclaration(Cursor.kind)) {
376    Decl *D = getCursorDecl(Cursor);
377    assert(D && "Invalid declaration cursor");
378    if (D->getPCHLevel() > MaxPCHLevel)
379      return false;
380
381    if (D->isImplicit())
382      return false;
383  }
384
385  // If we have a range of interest, and this cursor doesn't intersect with it,
386  // we're done.
387  if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
388    SourceRange Range = getRawCursorExtent(Cursor);
389    if (Range.isInvalid() || CompareRegionOfInterest(Range))
390      return false;
391  }
392
393  switch (Visitor(Cursor, Parent, ClientData)) {
394  case CXChildVisit_Break:
395    return true;
396
397  case CXChildVisit_Continue:
398    return false;
399
400  case CXChildVisit_Recurse:
401    return VisitChildren(Cursor);
402  }
403
404  return false;
405}
406
407std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
408CursorVisitor::getPreprocessedEntities() {
409  PreprocessingRecord &PPRec
410    = *AU->getPreprocessor().getPreprocessingRecord();
411
412  bool OnlyLocalDecls
413    = !AU->isMainFileAST() && AU->getOnlyLocalDecls();
414
415  if (OnlyLocalDecls && RegionOfInterest.isValid()) {
416    // If we would only look at local declarations but we have a region of
417    // interest, check whether that region of interest is in the main file.
418    // If not, we should traverse all declarations.
419    // FIXME: My kingdom for a proper binary search approach to finding
420    // cursors!
421    std::pair<FileID, unsigned> Location
422      = AU->getSourceManager().getDecomposedInstantiationLoc(
423                                                   RegionOfInterest.getBegin());
424    if (Location.first != AU->getSourceManager().getMainFileID())
425      OnlyLocalDecls = false;
426  }
427
428  PreprocessingRecord::iterator StartEntity, EndEntity;
429  if (OnlyLocalDecls) {
430    StartEntity = AU->pp_entity_begin();
431    EndEntity = AU->pp_entity_end();
432  } else {
433    StartEntity = PPRec.begin();
434    EndEntity = PPRec.end();
435  }
436
437  // There is no region of interest; we have to walk everything.
438  if (RegionOfInterest.isInvalid())
439    return std::make_pair(StartEntity, EndEntity);
440
441  // Find the file in which the region of interest lands.
442  SourceManager &SM = AU->getSourceManager();
443  std::pair<FileID, unsigned> Begin
444    = SM.getDecomposedInstantiationLoc(RegionOfInterest.getBegin());
445  std::pair<FileID, unsigned> End
446    = SM.getDecomposedInstantiationLoc(RegionOfInterest.getEnd());
447
448  // The region of interest spans files; we have to walk everything.
449  if (Begin.first != End.first)
450    return std::make_pair(StartEntity, EndEntity);
451
452  ASTUnit::PreprocessedEntitiesByFileMap &ByFileMap
453    = AU->getPreprocessedEntitiesByFile();
454  if (ByFileMap.empty()) {
455    // Build the mapping from files to sets of preprocessed entities.
456    for (PreprocessingRecord::iterator E = StartEntity; E != EndEntity; ++E) {
457      std::pair<FileID, unsigned> P
458        = SM.getDecomposedInstantiationLoc((*E)->getSourceRange().getBegin());
459
460      ByFileMap[P.first].push_back(*E);
461    }
462  }
463
464  return std::make_pair(ByFileMap[Begin.first].begin(),
465                        ByFileMap[Begin.first].end());
466}
467
468/// \brief Visit the children of the given cursor.
469///
470/// \returns true if the visitation should be aborted, false if it
471/// should continue.
472bool CursorVisitor::VisitChildren(CXCursor Cursor) {
473  if (clang_isReference(Cursor.kind)) {
474    // By definition, references have no children.
475    return false;
476  }
477
478  // Set the Parent field to Cursor, then back to its old value once we're
479  // done.
480  SetParentRAII SetParent(Parent, StmtParent, Cursor);
481
482  if (clang_isDeclaration(Cursor.kind)) {
483    Decl *D = getCursorDecl(Cursor);
484    assert(D && "Invalid declaration cursor");
485    return VisitAttributes(D) || Visit(D);
486  }
487
488  if (clang_isStatement(Cursor.kind))
489    return Visit(getCursorStmt(Cursor));
490  if (clang_isExpression(Cursor.kind))
491    return Visit(getCursorExpr(Cursor));
492
493  if (clang_isTranslationUnit(Cursor.kind)) {
494    CXTranslationUnit tu = getCursorTU(Cursor);
495    ASTUnit *CXXUnit = static_cast<ASTUnit*>(tu->TUData);
496    if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() &&
497        RegionOfInterest.isInvalid()) {
498      for (ASTUnit::top_level_iterator TL = CXXUnit->top_level_begin(),
499                                    TLEnd = CXXUnit->top_level_end();
500           TL != TLEnd; ++TL) {
501        if (Visit(MakeCXCursor(*TL, tu), true))
502          return true;
503      }
504    } else if (VisitDeclContext(
505                            CXXUnit->getASTContext().getTranslationUnitDecl()))
506      return true;
507
508    // Walk the preprocessing record.
509    if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
510      // FIXME: Once we have the ability to deserialize a preprocessing record,
511      // do so.
512      PreprocessingRecord::iterator E, EEnd;
513      for (llvm::tie(E, EEnd) = getPreprocessedEntities(); E != EEnd; ++E) {
514        if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) {
515          if (Visit(MakeMacroInstantiationCursor(MI, tu)))
516            return true;
517
518          continue;
519        }
520
521        if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
522          if (Visit(MakeMacroDefinitionCursor(MD, tu)))
523            return true;
524
525          continue;
526        }
527
528        if (InclusionDirective *ID = dyn_cast<InclusionDirective>(*E)) {
529          if (Visit(MakeInclusionDirectiveCursor(ID, tu)))
530            return true;
531
532          continue;
533        }
534      }
535    }
536    return false;
537  }
538
539  // Nothing to visit at the moment.
540  return false;
541}
542
543bool CursorVisitor::VisitBlockDecl(BlockDecl *B) {
544  if (Visit(B->getSignatureAsWritten()->getTypeLoc()))
545    return true;
546
547  if (Stmt *Body = B->getBody())
548    return Visit(MakeCXCursor(Body, StmtParent, TU));
549
550  return false;
551}
552
553llvm::Optional<bool> CursorVisitor::shouldVisitCursor(CXCursor Cursor) {
554  if (RegionOfInterest.isValid()) {
555    SourceRange Range = getFullCursorExtent(Cursor, AU->getSourceManager());
556    if (Range.isInvalid())
557      return llvm::Optional<bool>();
558
559    switch (CompareRegionOfInterest(Range)) {
560    case RangeBefore:
561      // This declaration comes before the region of interest; skip it.
562      return llvm::Optional<bool>();
563
564    case RangeAfter:
565      // This declaration comes after the region of interest; we're done.
566      return false;
567
568    case RangeOverlap:
569      // This declaration overlaps the region of interest; visit it.
570      break;
571    }
572  }
573  return true;
574}
575
576bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
577  DeclContext::decl_iterator I = DC->decls_begin(), E = DC->decls_end();
578
579  // FIXME: Eventually remove.  This part of a hack to support proper
580  // iteration over all Decls contained lexically within an ObjC container.
581  SaveAndRestore<DeclContext::decl_iterator*> DI_saved(DI_current, &I);
582  SaveAndRestore<DeclContext::decl_iterator> DE_saved(DE_current, E);
583
584  for ( ; I != E; ++I) {
585    Decl *D = *I;
586    if (D->getLexicalDeclContext() != DC)
587      continue;
588    CXCursor Cursor = MakeCXCursor(D, TU);
589    const llvm::Optional<bool> &V = shouldVisitCursor(Cursor);
590    if (!V.hasValue())
591      continue;
592    if (!V.getValue())
593      return false;
594    if (Visit(Cursor, true))
595      return true;
596  }
597  return false;
598}
599
600bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
601  llvm_unreachable("Translation units are visited directly by Visit()");
602  return false;
603}
604
605bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
606  if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
607    return Visit(TSInfo->getTypeLoc());
608
609  return false;
610}
611
612bool CursorVisitor::VisitTagDecl(TagDecl *D) {
613  return VisitDeclContext(D);
614}
615
616bool CursorVisitor::VisitClassTemplateSpecializationDecl(
617                                          ClassTemplateSpecializationDecl *D) {
618  bool ShouldVisitBody = false;
619  switch (D->getSpecializationKind()) {
620  case TSK_Undeclared:
621  case TSK_ImplicitInstantiation:
622    // Nothing to visit
623    return false;
624
625  case TSK_ExplicitInstantiationDeclaration:
626  case TSK_ExplicitInstantiationDefinition:
627    break;
628
629  case TSK_ExplicitSpecialization:
630    ShouldVisitBody = true;
631    break;
632  }
633
634  // Visit the template arguments used in the specialization.
635  if (TypeSourceInfo *SpecType = D->getTypeAsWritten()) {
636    TypeLoc TL = SpecType->getTypeLoc();
637    if (TemplateSpecializationTypeLoc *TSTLoc
638          = dyn_cast<TemplateSpecializationTypeLoc>(&TL)) {
639      for (unsigned I = 0, N = TSTLoc->getNumArgs(); I != N; ++I)
640        if (VisitTemplateArgumentLoc(TSTLoc->getArgLoc(I)))
641          return true;
642    }
643  }
644
645  if (ShouldVisitBody && VisitCXXRecordDecl(D))
646    return true;
647
648  return false;
649}
650
651bool CursorVisitor::VisitClassTemplatePartialSpecializationDecl(
652                                   ClassTemplatePartialSpecializationDecl *D) {
653  // FIXME: Visit the "outer" template parameter lists on the TagDecl
654  // before visiting these template parameters.
655  if (VisitTemplateParameters(D->getTemplateParameters()))
656    return true;
657
658  // Visit the partial specialization arguments.
659  const TemplateArgumentLoc *TemplateArgs = D->getTemplateArgsAsWritten();
660  for (unsigned I = 0, N = D->getNumTemplateArgsAsWritten(); I != N; ++I)
661    if (VisitTemplateArgumentLoc(TemplateArgs[I]))
662      return true;
663
664  return VisitCXXRecordDecl(D);
665}
666
667bool CursorVisitor::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
668  // Visit the default argument.
669  if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
670    if (TypeSourceInfo *DefArg = D->getDefaultArgumentInfo())
671      if (Visit(DefArg->getTypeLoc()))
672        return true;
673
674  return false;
675}
676
677bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
678  if (Expr *Init = D->getInitExpr())
679    return Visit(MakeCXCursor(Init, StmtParent, TU));
680  return false;
681}
682
683bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
684  if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
685    if (Visit(TSInfo->getTypeLoc()))
686      return true;
687
688  return false;
689}
690
691/// \brief Compare two base or member initializers based on their source order.
692static int CompareCXXCtorInitializers(const void* Xp, const void *Yp) {
693  CXXCtorInitializer const * const *X
694    = static_cast<CXXCtorInitializer const * const *>(Xp);
695  CXXCtorInitializer const * const *Y
696    = static_cast<CXXCtorInitializer const * const *>(Yp);
697
698  if ((*X)->getSourceOrder() < (*Y)->getSourceOrder())
699    return -1;
700  else if ((*X)->getSourceOrder() > (*Y)->getSourceOrder())
701    return 1;
702  else
703    return 0;
704}
705
706bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
707  if (TypeSourceInfo *TSInfo = ND->getTypeSourceInfo()) {
708    // Visit the function declaration's syntactic components in the order
709    // written. This requires a bit of work.
710    TypeLoc TL = TSInfo->getTypeLoc().IgnoreParens();
711    FunctionTypeLoc *FTL = dyn_cast<FunctionTypeLoc>(&TL);
712
713    // If we have a function declared directly (without the use of a typedef),
714    // visit just the return type. Otherwise, just visit the function's type
715    // now.
716    if ((FTL && !isa<CXXConversionDecl>(ND) && Visit(FTL->getResultLoc())) ||
717        (!FTL && Visit(TL)))
718      return true;
719
720    // Visit the nested-name-specifier, if present.
721    if (NestedNameSpecifier *Qualifier = ND->getQualifier())
722      if (VisitNestedNameSpecifier(Qualifier, ND->getQualifierRange()))
723        return true;
724
725    // Visit the declaration name.
726    if (VisitDeclarationNameInfo(ND->getNameInfo()))
727      return true;
728
729    // FIXME: Visit explicitly-specified template arguments!
730
731    // Visit the function parameters, if we have a function type.
732    if (FTL && VisitFunctionTypeLoc(*FTL, true))
733      return true;
734
735    // FIXME: Attributes?
736  }
737
738  if (ND->isThisDeclarationADefinition()) {
739    if (CXXConstructorDecl *Constructor = dyn_cast<CXXConstructorDecl>(ND)) {
740      // Find the initializers that were written in the source.
741      llvm::SmallVector<CXXCtorInitializer *, 4> WrittenInits;
742      for (CXXConstructorDecl::init_iterator I = Constructor->init_begin(),
743                                          IEnd = Constructor->init_end();
744           I != IEnd; ++I) {
745        if (!(*I)->isWritten())
746          continue;
747
748        WrittenInits.push_back(*I);
749      }
750
751      // Sort the initializers in source order
752      llvm::array_pod_sort(WrittenInits.begin(), WrittenInits.end(),
753                           &CompareCXXCtorInitializers);
754
755      // Visit the initializers in source order
756      for (unsigned I = 0, N = WrittenInits.size(); I != N; ++I) {
757        CXXCtorInitializer *Init = WrittenInits[I];
758        if (Init->isAnyMemberInitializer()) {
759          if (Visit(MakeCursorMemberRef(Init->getAnyMember(),
760                                        Init->getMemberLocation(), TU)))
761            return true;
762        } else if (TypeSourceInfo *BaseInfo = Init->getBaseClassInfo()) {
763          if (Visit(BaseInfo->getTypeLoc()))
764            return true;
765        }
766
767        // Visit the initializer value.
768        if (Expr *Initializer = Init->getInit())
769          if (Visit(MakeCXCursor(Initializer, ND, TU)))
770            return true;
771      }
772    }
773
774    if (Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
775      return true;
776  }
777
778  return false;
779}
780
781bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
782  if (VisitDeclaratorDecl(D))
783    return true;
784
785  if (Expr *BitWidth = D->getBitWidth())
786    return Visit(MakeCXCursor(BitWidth, StmtParent, TU));
787
788  return false;
789}
790
791bool CursorVisitor::VisitVarDecl(VarDecl *D) {
792  if (VisitDeclaratorDecl(D))
793    return true;
794
795  if (Expr *Init = D->getInit())
796    return Visit(MakeCXCursor(Init, StmtParent, TU));
797
798  return false;
799}
800
801bool CursorVisitor::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
802  if (VisitDeclaratorDecl(D))
803    return true;
804
805  if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
806    if (Expr *DefArg = D->getDefaultArgument())
807      return Visit(MakeCXCursor(DefArg, StmtParent, TU));
808
809  return false;
810}
811
812bool CursorVisitor::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
813  // FIXME: Visit the "outer" template parameter lists on the FunctionDecl
814  // before visiting these template parameters.
815  if (VisitTemplateParameters(D->getTemplateParameters()))
816    return true;
817
818  return VisitFunctionDecl(D->getTemplatedDecl());
819}
820
821bool CursorVisitor::VisitClassTemplateDecl(ClassTemplateDecl *D) {
822  // FIXME: Visit the "outer" template parameter lists on the TagDecl
823  // before visiting these template parameters.
824  if (VisitTemplateParameters(D->getTemplateParameters()))
825    return true;
826
827  return VisitCXXRecordDecl(D->getTemplatedDecl());
828}
829
830bool CursorVisitor::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
831  if (VisitTemplateParameters(D->getTemplateParameters()))
832    return true;
833
834  if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited() &&
835      VisitTemplateArgumentLoc(D->getDefaultArgument()))
836    return true;
837
838  return false;
839}
840
841bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
842  if (TypeSourceInfo *TSInfo = ND->getResultTypeSourceInfo())
843    if (Visit(TSInfo->getTypeLoc()))
844      return true;
845
846  for (ObjCMethodDecl::param_iterator P = ND->param_begin(),
847       PEnd = ND->param_end();
848       P != PEnd; ++P) {
849    if (Visit(MakeCXCursor(*P, TU)))
850      return true;
851  }
852
853  if (ND->isThisDeclarationADefinition() &&
854      Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
855    return true;
856
857  return false;
858}
859
860namespace {
861  struct ContainerDeclsSort {
862    SourceManager &SM;
863    ContainerDeclsSort(SourceManager &sm) : SM(sm) {}
864    bool operator()(Decl *A, Decl *B) {
865      SourceLocation L_A = A->getLocStart();
866      SourceLocation L_B = B->getLocStart();
867      assert(L_A.isValid() && L_B.isValid());
868      return SM.isBeforeInTranslationUnit(L_A, L_B);
869    }
870  };
871}
872
873bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
874  // FIXME: Eventually convert back to just 'VisitDeclContext()'.  Essentially
875  // an @implementation can lexically contain Decls that are not properly
876  // nested in the AST.  When we identify such cases, we need to retrofit
877  // this nesting here.
878  if (!DI_current)
879    return VisitDeclContext(D);
880
881  // Scan the Decls that immediately come after the container
882  // in the current DeclContext.  If any fall within the
883  // container's lexical region, stash them into a vector
884  // for later processing.
885  llvm::SmallVector<Decl *, 24> DeclsInContainer;
886  SourceLocation EndLoc = D->getSourceRange().getEnd();
887  SourceManager &SM = AU->getSourceManager();
888  if (EndLoc.isValid()) {
889    DeclContext::decl_iterator next = *DI_current;
890    while (++next != DE_current) {
891      Decl *D_next = *next;
892      if (!D_next)
893        break;
894      SourceLocation L = D_next->getLocStart();
895      if (!L.isValid())
896        break;
897      if (SM.isBeforeInTranslationUnit(L, EndLoc)) {
898        *DI_current = next;
899        DeclsInContainer.push_back(D_next);
900        continue;
901      }
902      break;
903    }
904  }
905
906  // The common case.
907  if (DeclsInContainer.empty())
908    return VisitDeclContext(D);
909
910  // Get all the Decls in the DeclContext, and sort them with the
911  // additional ones we've collected.  Then visit them.
912  for (DeclContext::decl_iterator I = D->decls_begin(), E = D->decls_end();
913       I!=E; ++I) {
914    Decl *subDecl = *I;
915    if (!subDecl || subDecl->getLexicalDeclContext() != D ||
916        subDecl->getLocStart().isInvalid())
917      continue;
918    DeclsInContainer.push_back(subDecl);
919  }
920
921  // Now sort the Decls so that they appear in lexical order.
922  std::sort(DeclsInContainer.begin(), DeclsInContainer.end(),
923            ContainerDeclsSort(SM));
924
925  // Now visit the decls.
926  for (llvm::SmallVectorImpl<Decl*>::iterator I = DeclsInContainer.begin(),
927         E = DeclsInContainer.end(); I != E; ++I) {
928    CXCursor Cursor = MakeCXCursor(*I, TU);
929    const llvm::Optional<bool> &V = shouldVisitCursor(Cursor);
930    if (!V.hasValue())
931      continue;
932    if (!V.getValue())
933      return false;
934    if (Visit(Cursor, true))
935      return true;
936  }
937  return false;
938}
939
940bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
941  if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
942                                   TU)))
943    return true;
944
945  ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
946  for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
947         E = ND->protocol_end(); I != E; ++I, ++PL)
948    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
949      return true;
950
951  return VisitObjCContainerDecl(ND);
952}
953
954bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
955  ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
956  for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
957       E = PID->protocol_end(); I != E; ++I, ++PL)
958    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
959      return true;
960
961  return VisitObjCContainerDecl(PID);
962}
963
964bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
965  if (PD->getTypeSourceInfo() && Visit(PD->getTypeSourceInfo()->getTypeLoc()))
966    return true;
967
968  // FIXME: This implements a workaround with @property declarations also being
969  // installed in the DeclContext for the @interface.  Eventually this code
970  // should be removed.
971  ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
972  if (!CDecl || !CDecl->IsClassExtension())
973    return false;
974
975  ObjCInterfaceDecl *ID = CDecl->getClassInterface();
976  if (!ID)
977    return false;
978
979  IdentifierInfo *PropertyId = PD->getIdentifier();
980  ObjCPropertyDecl *prevDecl =
981    ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId);
982
983  if (!prevDecl)
984    return false;
985
986  // Visit synthesized methods since they will be skipped when visiting
987  // the @interface.
988  if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
989    if (MD->isSynthesized() && MD->getLexicalDeclContext() == CDecl)
990      if (Visit(MakeCXCursor(MD, TU)))
991        return true;
992
993  if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
994    if (MD->isSynthesized() && MD->getLexicalDeclContext() == CDecl)
995      if (Visit(MakeCXCursor(MD, TU)))
996        return true;
997
998  return false;
999}
1000
1001bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
1002  // Issue callbacks for super class.
1003  if (D->getSuperClass() &&
1004      Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
1005                                        D->getSuperClassLoc(),
1006                                        TU)))
1007    return true;
1008
1009  ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
1010  for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
1011         E = D->protocol_end(); I != E; ++I, ++PL)
1012    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1013      return true;
1014
1015  return VisitObjCContainerDecl(D);
1016}
1017
1018bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
1019  return VisitObjCContainerDecl(D);
1020}
1021
1022bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
1023  // 'ID' could be null when dealing with invalid code.
1024  if (ObjCInterfaceDecl *ID = D->getClassInterface())
1025    if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
1026      return true;
1027
1028  return VisitObjCImplDecl(D);
1029}
1030
1031bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
1032#if 0
1033  // Issue callbacks for super class.
1034  // FIXME: No source location information!
1035  if (D->getSuperClass() &&
1036      Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
1037                                        D->getSuperClassLoc(),
1038                                        TU)))
1039    return true;
1040#endif
1041
1042  return VisitObjCImplDecl(D);
1043}
1044
1045bool CursorVisitor::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
1046  ObjCForwardProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
1047  for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(),
1048                                                  E = D->protocol_end();
1049       I != E; ++I, ++PL)
1050    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1051      return true;
1052
1053  return false;
1054}
1055
1056bool CursorVisitor::VisitObjCClassDecl(ObjCClassDecl *D) {
1057  for (ObjCClassDecl::iterator C = D->begin(), CEnd = D->end(); C != CEnd; ++C)
1058    if (Visit(MakeCursorObjCClassRef(C->getInterface(), C->getLocation(), TU)))
1059      return true;
1060
1061  return false;
1062}
1063
1064bool CursorVisitor::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PD) {
1065  if (ObjCIvarDecl *Ivar = PD->getPropertyIvarDecl())
1066    return Visit(MakeCursorMemberRef(Ivar, PD->getPropertyIvarDeclLoc(), TU));
1067
1068  return false;
1069}
1070
1071bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
1072  return VisitDeclContext(D);
1073}
1074
1075bool CursorVisitor::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
1076  // Visit nested-name-specifier.
1077  if (NestedNameSpecifier *Qualifier = D->getQualifier())
1078    if (VisitNestedNameSpecifier(Qualifier, D->getQualifierRange()))
1079      return true;
1080
1081  return Visit(MakeCursorNamespaceRef(D->getAliasedNamespace(),
1082                                      D->getTargetNameLoc(), TU));
1083}
1084
1085bool CursorVisitor::VisitUsingDecl(UsingDecl *D) {
1086  // Visit nested-name-specifier.
1087  if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameDecl())
1088    if (VisitNestedNameSpecifier(Qualifier, D->getNestedNameRange()))
1089      return true;
1090
1091  if (Visit(MakeCursorOverloadedDeclRef(D, D->getLocation(), TU)))
1092    return true;
1093
1094  return VisitDeclarationNameInfo(D->getNameInfo());
1095}
1096
1097bool CursorVisitor::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
1098  // Visit nested-name-specifier.
1099  if (NestedNameSpecifier *Qualifier = D->getQualifier())
1100    if (VisitNestedNameSpecifier(Qualifier, D->getQualifierRange()))
1101      return true;
1102
1103  return Visit(MakeCursorNamespaceRef(D->getNominatedNamespaceAsWritten(),
1104                                      D->getIdentLocation(), TU));
1105}
1106
1107bool CursorVisitor::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
1108  // Visit nested-name-specifier.
1109  if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameSpecifier())
1110    if (VisitNestedNameSpecifier(Qualifier, D->getTargetNestedNameRange()))
1111      return true;
1112
1113  return VisitDeclarationNameInfo(D->getNameInfo());
1114}
1115
1116bool CursorVisitor::VisitUnresolvedUsingTypenameDecl(
1117                                               UnresolvedUsingTypenameDecl *D) {
1118  // Visit nested-name-specifier.
1119  if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameSpecifier())
1120    if (VisitNestedNameSpecifier(Qualifier, D->getTargetNestedNameRange()))
1121      return true;
1122
1123  return false;
1124}
1125
1126bool CursorVisitor::VisitDeclarationNameInfo(DeclarationNameInfo Name) {
1127  switch (Name.getName().getNameKind()) {
1128  case clang::DeclarationName::Identifier:
1129  case clang::DeclarationName::CXXLiteralOperatorName:
1130  case clang::DeclarationName::CXXOperatorName:
1131  case clang::DeclarationName::CXXUsingDirective:
1132    return false;
1133
1134  case clang::DeclarationName::CXXConstructorName:
1135  case clang::DeclarationName::CXXDestructorName:
1136  case clang::DeclarationName::CXXConversionFunctionName:
1137    if (TypeSourceInfo *TSInfo = Name.getNamedTypeInfo())
1138      return Visit(TSInfo->getTypeLoc());
1139    return false;
1140
1141  case clang::DeclarationName::ObjCZeroArgSelector:
1142  case clang::DeclarationName::ObjCOneArgSelector:
1143  case clang::DeclarationName::ObjCMultiArgSelector:
1144    // FIXME: Per-identifier location info?
1145    return false;
1146  }
1147
1148  return false;
1149}
1150
1151bool CursorVisitor::VisitNestedNameSpecifier(NestedNameSpecifier *NNS,
1152                                             SourceRange Range) {
1153  // FIXME: This whole routine is a hack to work around the lack of proper
1154  // source information in nested-name-specifiers (PR5791). Since we do have
1155  // a beginning source location, we can visit the first component of the
1156  // nested-name-specifier, if it's a single-token component.
1157  if (!NNS)
1158    return false;
1159
1160  // Get the first component in the nested-name-specifier.
1161  while (NestedNameSpecifier *Prefix = NNS->getPrefix())
1162    NNS = Prefix;
1163
1164  switch (NNS->getKind()) {
1165  case NestedNameSpecifier::Namespace:
1166    // FIXME: The token at this source location might actually have been a
1167    // namespace alias, but we don't model that. Lame!
1168    return Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(), Range.getBegin(),
1169                                        TU));
1170
1171  case NestedNameSpecifier::TypeSpec: {
1172    // If the type has a form where we know that the beginning of the source
1173    // range matches up with a reference cursor. Visit the appropriate reference
1174    // cursor.
1175    Type *T = NNS->getAsType();
1176    if (const TypedefType *Typedef = dyn_cast<TypedefType>(T))
1177      return Visit(MakeCursorTypeRef(Typedef->getDecl(), Range.getBegin(), TU));
1178    if (const TagType *Tag = dyn_cast<TagType>(T))
1179      return Visit(MakeCursorTypeRef(Tag->getDecl(), Range.getBegin(), TU));
1180    if (const TemplateSpecializationType *TST
1181                                      = dyn_cast<TemplateSpecializationType>(T))
1182      return VisitTemplateName(TST->getTemplateName(), Range.getBegin());
1183    break;
1184  }
1185
1186  case NestedNameSpecifier::TypeSpecWithTemplate:
1187  case NestedNameSpecifier::Global:
1188  case NestedNameSpecifier::Identifier:
1189    break;
1190  }
1191
1192  return false;
1193}
1194
1195bool CursorVisitor::VisitTemplateParameters(
1196                                          const TemplateParameterList *Params) {
1197  if (!Params)
1198    return false;
1199
1200  for (TemplateParameterList::const_iterator P = Params->begin(),
1201                                          PEnd = Params->end();
1202       P != PEnd; ++P) {
1203    if (Visit(MakeCXCursor(*P, TU)))
1204      return true;
1205  }
1206
1207  return false;
1208}
1209
1210bool CursorVisitor::VisitTemplateName(TemplateName Name, SourceLocation Loc) {
1211  switch (Name.getKind()) {
1212  case TemplateName::Template:
1213    return Visit(MakeCursorTemplateRef(Name.getAsTemplateDecl(), Loc, TU));
1214
1215  case TemplateName::OverloadedTemplate:
1216    // Visit the overloaded template set.
1217    if (Visit(MakeCursorOverloadedDeclRef(Name, Loc, TU)))
1218      return true;
1219
1220    return false;
1221
1222  case TemplateName::DependentTemplate:
1223    // FIXME: Visit nested-name-specifier.
1224    return false;
1225
1226  case TemplateName::QualifiedTemplate:
1227    // FIXME: Visit nested-name-specifier.
1228    return Visit(MakeCursorTemplateRef(
1229                                  Name.getAsQualifiedTemplateName()->getDecl(),
1230                                       Loc, TU));
1231
1232  case TemplateName::SubstTemplateTemplateParmPack:
1233    return Visit(MakeCursorTemplateRef(
1234                  Name.getAsSubstTemplateTemplateParmPack()->getParameterPack(),
1235                                       Loc, TU));
1236  }
1237
1238  return false;
1239}
1240
1241bool CursorVisitor::VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL) {
1242  switch (TAL.getArgument().getKind()) {
1243  case TemplateArgument::Null:
1244  case TemplateArgument::Integral:
1245  case TemplateArgument::Pack:
1246    return false;
1247
1248  case TemplateArgument::Type:
1249    if (TypeSourceInfo *TSInfo = TAL.getTypeSourceInfo())
1250      return Visit(TSInfo->getTypeLoc());
1251    return false;
1252
1253  case TemplateArgument::Declaration:
1254    if (Expr *E = TAL.getSourceDeclExpression())
1255      return Visit(MakeCXCursor(E, StmtParent, TU));
1256    return false;
1257
1258  case TemplateArgument::Expression:
1259    if (Expr *E = TAL.getSourceExpression())
1260      return Visit(MakeCXCursor(E, StmtParent, TU));
1261    return false;
1262
1263  case TemplateArgument::Template:
1264  case TemplateArgument::TemplateExpansion:
1265    return VisitTemplateName(TAL.getArgument().getAsTemplateOrTemplatePattern(),
1266                             TAL.getTemplateNameLoc());
1267  }
1268
1269  return false;
1270}
1271
1272bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
1273  return VisitDeclContext(D);
1274}
1275
1276bool CursorVisitor::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
1277  return Visit(TL.getUnqualifiedLoc());
1278}
1279
1280bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
1281  ASTContext &Context = AU->getASTContext();
1282
1283  // Some builtin types (such as Objective-C's "id", "sel", and
1284  // "Class") have associated declarations. Create cursors for those.
1285  QualType VisitType;
1286  switch (TL.getType()->getAs<BuiltinType>()->getKind()) {
1287  case BuiltinType::Void:
1288  case BuiltinType::Bool:
1289  case BuiltinType::Char_U:
1290  case BuiltinType::UChar:
1291  case BuiltinType::Char16:
1292  case BuiltinType::Char32:
1293  case BuiltinType::UShort:
1294  case BuiltinType::UInt:
1295  case BuiltinType::ULong:
1296  case BuiltinType::ULongLong:
1297  case BuiltinType::UInt128:
1298  case BuiltinType::Char_S:
1299  case BuiltinType::SChar:
1300  case BuiltinType::WChar_U:
1301  case BuiltinType::WChar_S:
1302  case BuiltinType::Short:
1303  case BuiltinType::Int:
1304  case BuiltinType::Long:
1305  case BuiltinType::LongLong:
1306  case BuiltinType::Int128:
1307  case BuiltinType::Float:
1308  case BuiltinType::Double:
1309  case BuiltinType::LongDouble:
1310  case BuiltinType::NullPtr:
1311  case BuiltinType::Overload:
1312  case BuiltinType::Dependent:
1313    break;
1314
1315  case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor?
1316    break;
1317
1318  case BuiltinType::ObjCId:
1319    VisitType = Context.getObjCIdType();
1320    break;
1321
1322  case BuiltinType::ObjCClass:
1323    VisitType = Context.getObjCClassType();
1324    break;
1325
1326  case BuiltinType::ObjCSel:
1327    VisitType = Context.getObjCSelType();
1328    break;
1329  }
1330
1331  if (!VisitType.isNull()) {
1332    if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
1333      return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
1334                                     TU));
1335  }
1336
1337  return false;
1338}
1339
1340bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
1341  return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU));
1342}
1343
1344bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
1345  return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1346}
1347
1348bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
1349  return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1350}
1351
1352bool CursorVisitor::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
1353  // FIXME: We can't visit the template type parameter, because there's
1354  // no context information with which we can match up the depth/index in the
1355  // type to the appropriate
1356  return false;
1357}
1358
1359bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
1360  if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU)))
1361    return true;
1362
1363  return false;
1364}
1365
1366bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
1367  if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
1368    return true;
1369
1370  for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1371    if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1372                                        TU)))
1373      return true;
1374  }
1375
1376  return false;
1377}
1378
1379bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
1380  return Visit(TL.getPointeeLoc());
1381}
1382
1383bool CursorVisitor::VisitParenTypeLoc(ParenTypeLoc TL) {
1384  return Visit(TL.getInnerLoc());
1385}
1386
1387bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
1388  return Visit(TL.getPointeeLoc());
1389}
1390
1391bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
1392  return Visit(TL.getPointeeLoc());
1393}
1394
1395bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
1396  return Visit(TL.getPointeeLoc());
1397}
1398
1399bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
1400  return Visit(TL.getPointeeLoc());
1401}
1402
1403bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
1404  return Visit(TL.getPointeeLoc());
1405}
1406
1407bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL,
1408                                         bool SkipResultType) {
1409  if (!SkipResultType && Visit(TL.getResultLoc()))
1410    return true;
1411
1412  for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1413    if (Decl *D = TL.getArg(I))
1414      if (Visit(MakeCXCursor(D, TU)))
1415        return true;
1416
1417  return false;
1418}
1419
1420bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
1421  if (Visit(TL.getElementLoc()))
1422    return true;
1423
1424  if (Expr *Size = TL.getSizeExpr())
1425    return Visit(MakeCXCursor(Size, StmtParent, TU));
1426
1427  return false;
1428}
1429
1430bool CursorVisitor::VisitTemplateSpecializationTypeLoc(
1431                                             TemplateSpecializationTypeLoc TL) {
1432  // Visit the template name.
1433  if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1434                        TL.getTemplateNameLoc()))
1435    return true;
1436
1437  // Visit the template arguments.
1438  for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1439    if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1440      return true;
1441
1442  return false;
1443}
1444
1445bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
1446  return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
1447}
1448
1449bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
1450  if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1451    return Visit(TSInfo->getTypeLoc());
1452
1453  return false;
1454}
1455
1456bool CursorVisitor::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
1457  return Visit(TL.getPatternLoc());
1458}
1459
1460bool CursorVisitor::VisitCXXRecordDecl(CXXRecordDecl *D) {
1461  if (D->isDefinition()) {
1462    for (CXXRecordDecl::base_class_iterator I = D->bases_begin(),
1463         E = D->bases_end(); I != E; ++I) {
1464      if (Visit(cxcursor::MakeCursorCXXBaseSpecifier(I, TU)))
1465        return true;
1466    }
1467  }
1468
1469  return VisitTagDecl(D);
1470}
1471
1472bool CursorVisitor::VisitAttributes(Decl *D) {
1473  for (AttrVec::const_iterator i = D->attr_begin(), e = D->attr_end();
1474       i != e; ++i)
1475    if (Visit(MakeCXCursor(*i, D, TU)))
1476        return true;
1477
1478  return false;
1479}
1480
1481//===----------------------------------------------------------------------===//
1482// Data-recursive visitor methods.
1483//===----------------------------------------------------------------------===//
1484
1485namespace {
1486#define DEF_JOB(NAME, DATA, KIND)\
1487class NAME : public VisitorJob {\
1488public:\
1489  NAME(DATA *d, CXCursor parent) : VisitorJob(parent, VisitorJob::KIND, d) {} \
1490  static bool classof(const VisitorJob *VJ) { return VJ->getKind() == KIND; }\
1491  DATA *get() const { return static_cast<DATA*>(data[0]); }\
1492};
1493
1494DEF_JOB(StmtVisit, Stmt, StmtVisitKind)
1495DEF_JOB(MemberExprParts, MemberExpr, MemberExprPartsKind)
1496DEF_JOB(DeclRefExprParts, DeclRefExpr, DeclRefExprPartsKind)
1497DEF_JOB(OverloadExprParts, OverloadExpr, OverloadExprPartsKind)
1498DEF_JOB(ExplicitTemplateArgsVisit, ExplicitTemplateArgumentList,
1499        ExplicitTemplateArgsVisitKind)
1500#undef DEF_JOB
1501
1502class DeclVisit : public VisitorJob {
1503public:
1504  DeclVisit(Decl *d, CXCursor parent, bool isFirst) :
1505    VisitorJob(parent, VisitorJob::DeclVisitKind,
1506               d, isFirst ? (void*) 1 : (void*) 0) {}
1507  static bool classof(const VisitorJob *VJ) {
1508    return VJ->getKind() == DeclVisitKind;
1509  }
1510  Decl *get() const { return static_cast<Decl*>(data[0]); }
1511  bool isFirst() const { return data[1] ? true : false; }
1512};
1513class TypeLocVisit : public VisitorJob {
1514public:
1515  TypeLocVisit(TypeLoc tl, CXCursor parent) :
1516    VisitorJob(parent, VisitorJob::TypeLocVisitKind,
1517               tl.getType().getAsOpaquePtr(), tl.getOpaqueData()) {}
1518
1519  static bool classof(const VisitorJob *VJ) {
1520    return VJ->getKind() == TypeLocVisitKind;
1521  }
1522
1523  TypeLoc get() const {
1524    QualType T = QualType::getFromOpaquePtr(data[0]);
1525    return TypeLoc(T, data[1]);
1526  }
1527};
1528
1529class LabelRefVisit : public VisitorJob {
1530public:
1531  LabelRefVisit(LabelStmt *LS, SourceLocation labelLoc, CXCursor parent)
1532    : VisitorJob(parent, VisitorJob::LabelRefVisitKind, LS,
1533                 (void*) labelLoc.getRawEncoding()) {}
1534
1535  static bool classof(const VisitorJob *VJ) {
1536    return VJ->getKind() == VisitorJob::LabelRefVisitKind;
1537  }
1538  LabelStmt *get() const { return static_cast<LabelStmt*>(data[0]); }
1539  SourceLocation getLoc() const {
1540    return SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]); }
1541};
1542class NestedNameSpecifierVisit : public VisitorJob {
1543public:
1544  NestedNameSpecifierVisit(NestedNameSpecifier *NS, SourceRange R,
1545                           CXCursor parent)
1546    : VisitorJob(parent, VisitorJob::NestedNameSpecifierVisitKind,
1547                 NS, (void*) R.getBegin().getRawEncoding(),
1548                 (void*) R.getEnd().getRawEncoding()) {}
1549  static bool classof(const VisitorJob *VJ) {
1550    return VJ->getKind() == VisitorJob::NestedNameSpecifierVisitKind;
1551  }
1552  NestedNameSpecifier *get() const {
1553    return static_cast<NestedNameSpecifier*>(data[0]);
1554  }
1555  SourceRange getSourceRange() const {
1556    SourceLocation A =
1557      SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]);
1558    SourceLocation B =
1559      SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[2]);
1560    return SourceRange(A, B);
1561  }
1562};
1563class DeclarationNameInfoVisit : public VisitorJob {
1564public:
1565  DeclarationNameInfoVisit(Stmt *S, CXCursor parent)
1566    : VisitorJob(parent, VisitorJob::DeclarationNameInfoVisitKind, S) {}
1567  static bool classof(const VisitorJob *VJ) {
1568    return VJ->getKind() == VisitorJob::DeclarationNameInfoVisitKind;
1569  }
1570  DeclarationNameInfo get() const {
1571    Stmt *S = static_cast<Stmt*>(data[0]);
1572    switch (S->getStmtClass()) {
1573    default:
1574      llvm_unreachable("Unhandled Stmt");
1575    case Stmt::CXXDependentScopeMemberExprClass:
1576      return cast<CXXDependentScopeMemberExpr>(S)->getMemberNameInfo();
1577    case Stmt::DependentScopeDeclRefExprClass:
1578      return cast<DependentScopeDeclRefExpr>(S)->getNameInfo();
1579    }
1580  }
1581};
1582class MemberRefVisit : public VisitorJob {
1583public:
1584  MemberRefVisit(FieldDecl *D, SourceLocation L, CXCursor parent)
1585    : VisitorJob(parent, VisitorJob::MemberRefVisitKind, D,
1586                 (void*) L.getRawEncoding()) {}
1587  static bool classof(const VisitorJob *VJ) {
1588    return VJ->getKind() == VisitorJob::MemberRefVisitKind;
1589  }
1590  FieldDecl *get() const {
1591    return static_cast<FieldDecl*>(data[0]);
1592  }
1593  SourceLocation getLoc() const {
1594    return SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]);
1595  }
1596};
1597class EnqueueVisitor : public StmtVisitor<EnqueueVisitor, void> {
1598  VisitorWorkList &WL;
1599  CXCursor Parent;
1600public:
1601  EnqueueVisitor(VisitorWorkList &wl, CXCursor parent)
1602    : WL(wl), Parent(parent) {}
1603
1604  void VisitAddrLabelExpr(AddrLabelExpr *E);
1605  void VisitBlockExpr(BlockExpr *B);
1606  void VisitCompoundLiteralExpr(CompoundLiteralExpr *E);
1607  void VisitCompoundStmt(CompoundStmt *S);
1608  void VisitCXXDefaultArgExpr(CXXDefaultArgExpr *E) { /* Do nothing. */ }
1609  void VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E);
1610  void VisitCXXNewExpr(CXXNewExpr *E);
1611  void VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E);
1612  void VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E);
1613  void VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E);
1614  void VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E);
1615  void VisitCXXTypeidExpr(CXXTypeidExpr *E);
1616  void VisitCXXUnresolvedConstructExpr(CXXUnresolvedConstructExpr *E);
1617  void VisitCXXUuidofExpr(CXXUuidofExpr *E);
1618  void VisitDeclRefExpr(DeclRefExpr *D);
1619  void VisitDeclStmt(DeclStmt *S);
1620  void VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E);
1621  void VisitDesignatedInitExpr(DesignatedInitExpr *E);
1622  void VisitExplicitCastExpr(ExplicitCastExpr *E);
1623  void VisitForStmt(ForStmt *FS);
1624  void VisitGotoStmt(GotoStmt *GS);
1625  void VisitIfStmt(IfStmt *If);
1626  void VisitInitListExpr(InitListExpr *IE);
1627  void VisitMemberExpr(MemberExpr *M);
1628  void VisitOffsetOfExpr(OffsetOfExpr *E);
1629  void VisitObjCEncodeExpr(ObjCEncodeExpr *E);
1630  void VisitObjCMessageExpr(ObjCMessageExpr *M);
1631  void VisitOverloadExpr(OverloadExpr *E);
1632  void VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E);
1633  void VisitStmt(Stmt *S);
1634  void VisitSwitchStmt(SwitchStmt *S);
1635  void VisitWhileStmt(WhileStmt *W);
1636  void VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E);
1637  void VisitBinaryTypeTraitExpr(BinaryTypeTraitExpr *E);
1638  void VisitUnresolvedMemberExpr(UnresolvedMemberExpr *U);
1639  void VisitVAArgExpr(VAArgExpr *E);
1640  // FIXME: Variadic templates SizeOfPackExpr!
1641
1642private:
1643  void AddDeclarationNameInfo(Stmt *S);
1644  void AddNestedNameSpecifier(NestedNameSpecifier *NS, SourceRange R);
1645  void AddExplicitTemplateArgs(const ExplicitTemplateArgumentList *A);
1646  void AddMemberRef(FieldDecl *D, SourceLocation L);
1647  void AddStmt(Stmt *S);
1648  void AddDecl(Decl *D, bool isFirst = true);
1649  void AddTypeLoc(TypeSourceInfo *TI);
1650  void EnqueueChildren(Stmt *S);
1651};
1652} // end anonyous namespace
1653
1654void EnqueueVisitor::AddDeclarationNameInfo(Stmt *S) {
1655  // 'S' should always be non-null, since it comes from the
1656  // statement we are visiting.
1657  WL.push_back(DeclarationNameInfoVisit(S, Parent));
1658}
1659void EnqueueVisitor::AddNestedNameSpecifier(NestedNameSpecifier *N,
1660                                            SourceRange R) {
1661  if (N)
1662    WL.push_back(NestedNameSpecifierVisit(N, R, Parent));
1663}
1664void EnqueueVisitor::AddStmt(Stmt *S) {
1665  if (S)
1666    WL.push_back(StmtVisit(S, Parent));
1667}
1668void EnqueueVisitor::AddDecl(Decl *D, bool isFirst) {
1669  if (D)
1670    WL.push_back(DeclVisit(D, Parent, isFirst));
1671}
1672void EnqueueVisitor::
1673  AddExplicitTemplateArgs(const ExplicitTemplateArgumentList *A) {
1674  if (A)
1675    WL.push_back(ExplicitTemplateArgsVisit(
1676                        const_cast<ExplicitTemplateArgumentList*>(A), Parent));
1677}
1678void EnqueueVisitor::AddMemberRef(FieldDecl *D, SourceLocation L) {
1679  if (D)
1680    WL.push_back(MemberRefVisit(D, L, Parent));
1681}
1682void EnqueueVisitor::AddTypeLoc(TypeSourceInfo *TI) {
1683  if (TI)
1684    WL.push_back(TypeLocVisit(TI->getTypeLoc(), Parent));
1685 }
1686void EnqueueVisitor::EnqueueChildren(Stmt *S) {
1687  unsigned size = WL.size();
1688  for (Stmt::child_iterator Child = S->child_begin(), ChildEnd = S->child_end();
1689       Child != ChildEnd; ++Child) {
1690    AddStmt(*Child);
1691  }
1692  if (size == WL.size())
1693    return;
1694  // Now reverse the entries we just added.  This will match the DFS
1695  // ordering performed by the worklist.
1696  VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
1697  std::reverse(I, E);
1698}
1699void EnqueueVisitor::VisitAddrLabelExpr(AddrLabelExpr *E) {
1700  WL.push_back(LabelRefVisit(E->getLabel(), E->getLabelLoc(), Parent));
1701}
1702void EnqueueVisitor::VisitBlockExpr(BlockExpr *B) {
1703  AddDecl(B->getBlockDecl());
1704}
1705void EnqueueVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) {
1706  EnqueueChildren(E);
1707  AddTypeLoc(E->getTypeSourceInfo());
1708}
1709void EnqueueVisitor::VisitCompoundStmt(CompoundStmt *S) {
1710  for (CompoundStmt::reverse_body_iterator I = S->body_rbegin(),
1711        E = S->body_rend(); I != E; ++I) {
1712    AddStmt(*I);
1713  }
1714}
1715void EnqueueVisitor::
1716VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E) {
1717  AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
1718  AddDeclarationNameInfo(E);
1719  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1720    AddNestedNameSpecifier(Qualifier, E->getQualifierRange());
1721  if (!E->isImplicitAccess())
1722    AddStmt(E->getBase());
1723}
1724void EnqueueVisitor::VisitCXXNewExpr(CXXNewExpr *E) {
1725  // Enqueue the initializer or constructor arguments.
1726  for (unsigned I = E->getNumConstructorArgs(); I > 0; --I)
1727    AddStmt(E->getConstructorArg(I-1));
1728  // Enqueue the array size, if any.
1729  AddStmt(E->getArraySize());
1730  // Enqueue the allocated type.
1731  AddTypeLoc(E->getAllocatedTypeSourceInfo());
1732  // Enqueue the placement arguments.
1733  for (unsigned I = E->getNumPlacementArgs(); I > 0; --I)
1734    AddStmt(E->getPlacementArg(I-1));
1735}
1736void EnqueueVisitor::VisitCXXOperatorCallExpr(CXXOperatorCallExpr *CE) {
1737  for (unsigned I = CE->getNumArgs(); I > 1 /* Yes, this is 1 */; --I)
1738    AddStmt(CE->getArg(I-1));
1739  AddStmt(CE->getCallee());
1740  AddStmt(CE->getArg(0));
1741}
1742void EnqueueVisitor::VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E) {
1743  // Visit the name of the type being destroyed.
1744  AddTypeLoc(E->getDestroyedTypeInfo());
1745  // Visit the scope type that looks disturbingly like the nested-name-specifier
1746  // but isn't.
1747  AddTypeLoc(E->getScopeTypeInfo());
1748  // Visit the nested-name-specifier.
1749  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1750    AddNestedNameSpecifier(Qualifier, E->getQualifierRange());
1751  // Visit base expression.
1752  AddStmt(E->getBase());
1753}
1754void EnqueueVisitor::VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E) {
1755  AddTypeLoc(E->getTypeSourceInfo());
1756}
1757void EnqueueVisitor::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E) {
1758  EnqueueChildren(E);
1759  AddTypeLoc(E->getTypeSourceInfo());
1760}
1761void EnqueueVisitor::VisitCXXTypeidExpr(CXXTypeidExpr *E) {
1762  EnqueueChildren(E);
1763  if (E->isTypeOperand())
1764    AddTypeLoc(E->getTypeOperandSourceInfo());
1765}
1766
1767void EnqueueVisitor::VisitCXXUnresolvedConstructExpr(CXXUnresolvedConstructExpr
1768                                                     *E) {
1769  EnqueueChildren(E);
1770  AddTypeLoc(E->getTypeSourceInfo());
1771}
1772void EnqueueVisitor::VisitCXXUuidofExpr(CXXUuidofExpr *E) {
1773  EnqueueChildren(E);
1774  if (E->isTypeOperand())
1775    AddTypeLoc(E->getTypeOperandSourceInfo());
1776}
1777void EnqueueVisitor::VisitDeclRefExpr(DeclRefExpr *DR) {
1778  if (DR->hasExplicitTemplateArgs()) {
1779    AddExplicitTemplateArgs(&DR->getExplicitTemplateArgs());
1780  }
1781  WL.push_back(DeclRefExprParts(DR, Parent));
1782}
1783void EnqueueVisitor::VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E) {
1784  AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
1785  AddDeclarationNameInfo(E);
1786  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1787    AddNestedNameSpecifier(Qualifier, E->getQualifierRange());
1788}
1789void EnqueueVisitor::VisitDeclStmt(DeclStmt *S) {
1790  unsigned size = WL.size();
1791  bool isFirst = true;
1792  for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end();
1793       D != DEnd; ++D) {
1794    AddDecl(*D, isFirst);
1795    isFirst = false;
1796  }
1797  if (size == WL.size())
1798    return;
1799  // Now reverse the entries we just added.  This will match the DFS
1800  // ordering performed by the worklist.
1801  VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
1802  std::reverse(I, E);
1803}
1804void EnqueueVisitor::VisitDesignatedInitExpr(DesignatedInitExpr *E) {
1805  AddStmt(E->getInit());
1806  typedef DesignatedInitExpr::Designator Designator;
1807  for (DesignatedInitExpr::reverse_designators_iterator
1808         D = E->designators_rbegin(), DEnd = E->designators_rend();
1809         D != DEnd; ++D) {
1810    if (D->isFieldDesignator()) {
1811      if (FieldDecl *Field = D->getField())
1812        AddMemberRef(Field, D->getFieldLoc());
1813      continue;
1814    }
1815    if (D->isArrayDesignator()) {
1816      AddStmt(E->getArrayIndex(*D));
1817      continue;
1818    }
1819    assert(D->isArrayRangeDesignator() && "Unknown designator kind");
1820    AddStmt(E->getArrayRangeEnd(*D));
1821    AddStmt(E->getArrayRangeStart(*D));
1822  }
1823}
1824void EnqueueVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) {
1825  EnqueueChildren(E);
1826  AddTypeLoc(E->getTypeInfoAsWritten());
1827}
1828void EnqueueVisitor::VisitForStmt(ForStmt *FS) {
1829  AddStmt(FS->getBody());
1830  AddStmt(FS->getInc());
1831  AddStmt(FS->getCond());
1832  AddDecl(FS->getConditionVariable());
1833  AddStmt(FS->getInit());
1834}
1835void EnqueueVisitor::VisitGotoStmt(GotoStmt *GS) {
1836  WL.push_back(LabelRefVisit(GS->getLabel(), GS->getLabelLoc(), Parent));
1837}
1838void EnqueueVisitor::VisitIfStmt(IfStmt *If) {
1839  AddStmt(If->getElse());
1840  AddStmt(If->getThen());
1841  AddStmt(If->getCond());
1842  AddDecl(If->getConditionVariable());
1843}
1844void EnqueueVisitor::VisitInitListExpr(InitListExpr *IE) {
1845  // We care about the syntactic form of the initializer list, only.
1846  if (InitListExpr *Syntactic = IE->getSyntacticForm())
1847    IE = Syntactic;
1848  EnqueueChildren(IE);
1849}
1850void EnqueueVisitor::VisitMemberExpr(MemberExpr *M) {
1851  WL.push_back(MemberExprParts(M, Parent));
1852
1853  // If the base of the member access expression is an implicit 'this', don't
1854  // visit it.
1855  // FIXME: If we ever want to show these implicit accesses, this will be
1856  // unfortunate. However, clang_getCursor() relies on this behavior.
1857  if (CXXThisExpr *This
1858            = llvm::dyn_cast<CXXThisExpr>(M->getBase()->IgnoreParenImpCasts()))
1859    if (This->isImplicit())
1860      return;
1861
1862  AddStmt(M->getBase());
1863}
1864void EnqueueVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) {
1865  AddTypeLoc(E->getEncodedTypeSourceInfo());
1866}
1867void EnqueueVisitor::VisitObjCMessageExpr(ObjCMessageExpr *M) {
1868  EnqueueChildren(M);
1869  AddTypeLoc(M->getClassReceiverTypeInfo());
1870}
1871void EnqueueVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) {
1872  // Visit the components of the offsetof expression.
1873  for (unsigned N = E->getNumComponents(), I = N; I > 0; --I) {
1874    typedef OffsetOfExpr::OffsetOfNode OffsetOfNode;
1875    const OffsetOfNode &Node = E->getComponent(I-1);
1876    switch (Node.getKind()) {
1877    case OffsetOfNode::Array:
1878      AddStmt(E->getIndexExpr(Node.getArrayExprIndex()));
1879      break;
1880    case OffsetOfNode::Field:
1881      AddMemberRef(Node.getField(), Node.getRange().getEnd());
1882      break;
1883    case OffsetOfNode::Identifier:
1884    case OffsetOfNode::Base:
1885      continue;
1886    }
1887  }
1888  // Visit the type into which we're computing the offset.
1889  AddTypeLoc(E->getTypeSourceInfo());
1890}
1891void EnqueueVisitor::VisitOverloadExpr(OverloadExpr *E) {
1892  AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
1893  WL.push_back(OverloadExprParts(E, Parent));
1894}
1895void EnqueueVisitor::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E) {
1896  EnqueueChildren(E);
1897  if (E->isArgumentType())
1898    AddTypeLoc(E->getArgumentTypeInfo());
1899}
1900void EnqueueVisitor::VisitStmt(Stmt *S) {
1901  EnqueueChildren(S);
1902}
1903void EnqueueVisitor::VisitSwitchStmt(SwitchStmt *S) {
1904  AddStmt(S->getBody());
1905  AddStmt(S->getCond());
1906  AddDecl(S->getConditionVariable());
1907}
1908
1909void EnqueueVisitor::VisitWhileStmt(WhileStmt *W) {
1910  AddStmt(W->getBody());
1911  AddStmt(W->getCond());
1912  AddDecl(W->getConditionVariable());
1913}
1914void EnqueueVisitor::VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E) {
1915  AddTypeLoc(E->getQueriedTypeSourceInfo());
1916}
1917
1918void EnqueueVisitor::VisitBinaryTypeTraitExpr(BinaryTypeTraitExpr *E) {
1919  AddTypeLoc(E->getRhsTypeSourceInfo());
1920  AddTypeLoc(E->getLhsTypeSourceInfo());
1921}
1922
1923void EnqueueVisitor::VisitUnresolvedMemberExpr(UnresolvedMemberExpr *U) {
1924  VisitOverloadExpr(U);
1925  if (!U->isImplicitAccess())
1926    AddStmt(U->getBase());
1927}
1928void EnqueueVisitor::VisitVAArgExpr(VAArgExpr *E) {
1929  AddStmt(E->getSubExpr());
1930  AddTypeLoc(E->getWrittenTypeInfo());
1931}
1932
1933void CursorVisitor::EnqueueWorkList(VisitorWorkList &WL, Stmt *S) {
1934  EnqueueVisitor(WL, MakeCXCursor(S, StmtParent, TU)).Visit(S);
1935}
1936
1937bool CursorVisitor::IsInRegionOfInterest(CXCursor C) {
1938  if (RegionOfInterest.isValid()) {
1939    SourceRange Range = getRawCursorExtent(C);
1940    if (Range.isInvalid() || CompareRegionOfInterest(Range))
1941      return false;
1942  }
1943  return true;
1944}
1945
1946bool CursorVisitor::RunVisitorWorkList(VisitorWorkList &WL) {
1947  while (!WL.empty()) {
1948    // Dequeue the worklist item.
1949    VisitorJob LI = WL.back();
1950    WL.pop_back();
1951
1952    // Set the Parent field, then back to its old value once we're done.
1953    SetParentRAII SetParent(Parent, StmtParent, LI.getParent());
1954
1955    switch (LI.getKind()) {
1956      case VisitorJob::DeclVisitKind: {
1957        Decl *D = cast<DeclVisit>(&LI)->get();
1958        if (!D)
1959          continue;
1960
1961        // For now, perform default visitation for Decls.
1962        if (Visit(MakeCXCursor(D, TU, cast<DeclVisit>(&LI)->isFirst())))
1963            return true;
1964
1965        continue;
1966      }
1967      case VisitorJob::ExplicitTemplateArgsVisitKind: {
1968        const ExplicitTemplateArgumentList *ArgList =
1969          cast<ExplicitTemplateArgsVisit>(&LI)->get();
1970        for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1971               *ArgEnd = Arg + ArgList->NumTemplateArgs;
1972               Arg != ArgEnd; ++Arg) {
1973          if (VisitTemplateArgumentLoc(*Arg))
1974            return true;
1975        }
1976        continue;
1977      }
1978      case VisitorJob::TypeLocVisitKind: {
1979        // Perform default visitation for TypeLocs.
1980        if (Visit(cast<TypeLocVisit>(&LI)->get()))
1981          return true;
1982        continue;
1983      }
1984      case VisitorJob::LabelRefVisitKind: {
1985        LabelStmt *LS = cast<LabelRefVisit>(&LI)->get();
1986        if (Visit(MakeCursorLabelRef(LS,
1987                                     cast<LabelRefVisit>(&LI)->getLoc(),
1988                                     TU)))
1989          return true;
1990        continue;
1991      }
1992      case VisitorJob::NestedNameSpecifierVisitKind: {
1993        NestedNameSpecifierVisit *V = cast<NestedNameSpecifierVisit>(&LI);
1994        if (VisitNestedNameSpecifier(V->get(), V->getSourceRange()))
1995          return true;
1996        continue;
1997      }
1998      case VisitorJob::DeclarationNameInfoVisitKind: {
1999        if (VisitDeclarationNameInfo(cast<DeclarationNameInfoVisit>(&LI)
2000                                     ->get()))
2001          return true;
2002        continue;
2003      }
2004      case VisitorJob::MemberRefVisitKind: {
2005        MemberRefVisit *V = cast<MemberRefVisit>(&LI);
2006        if (Visit(MakeCursorMemberRef(V->get(), V->getLoc(), TU)))
2007          return true;
2008        continue;
2009      }
2010      case VisitorJob::StmtVisitKind: {
2011        Stmt *S = cast<StmtVisit>(&LI)->get();
2012        if (!S)
2013          continue;
2014
2015        // Update the current cursor.
2016        CXCursor Cursor = MakeCXCursor(S, StmtParent, TU);
2017        if (!IsInRegionOfInterest(Cursor))
2018          continue;
2019        switch (Visitor(Cursor, Parent, ClientData)) {
2020          case CXChildVisit_Break: return true;
2021          case CXChildVisit_Continue: break;
2022          case CXChildVisit_Recurse:
2023            EnqueueWorkList(WL, S);
2024            break;
2025        }
2026        continue;
2027      }
2028      case VisitorJob::MemberExprPartsKind: {
2029        // Handle the other pieces in the MemberExpr besides the base.
2030        MemberExpr *M = cast<MemberExprParts>(&LI)->get();
2031
2032        // Visit the nested-name-specifier
2033        if (NestedNameSpecifier *Qualifier = M->getQualifier())
2034          if (VisitNestedNameSpecifier(Qualifier, M->getQualifierRange()))
2035            return true;
2036
2037        // Visit the declaration name.
2038        if (VisitDeclarationNameInfo(M->getMemberNameInfo()))
2039          return true;
2040
2041        // Visit the explicitly-specified template arguments, if any.
2042        if (M->hasExplicitTemplateArgs()) {
2043          for (const TemplateArgumentLoc *Arg = M->getTemplateArgs(),
2044               *ArgEnd = Arg + M->getNumTemplateArgs();
2045               Arg != ArgEnd; ++Arg) {
2046            if (VisitTemplateArgumentLoc(*Arg))
2047              return true;
2048          }
2049        }
2050        continue;
2051      }
2052      case VisitorJob::DeclRefExprPartsKind: {
2053        DeclRefExpr *DR = cast<DeclRefExprParts>(&LI)->get();
2054        // Visit nested-name-specifier, if present.
2055        if (NestedNameSpecifier *Qualifier = DR->getQualifier())
2056          if (VisitNestedNameSpecifier(Qualifier, DR->getQualifierRange()))
2057            return true;
2058        // Visit declaration name.
2059        if (VisitDeclarationNameInfo(DR->getNameInfo()))
2060          return true;
2061        continue;
2062      }
2063      case VisitorJob::OverloadExprPartsKind: {
2064        OverloadExpr *O = cast<OverloadExprParts>(&LI)->get();
2065        // Visit the nested-name-specifier.
2066        if (NestedNameSpecifier *Qualifier = O->getQualifier())
2067          if (VisitNestedNameSpecifier(Qualifier, O->getQualifierRange()))
2068            return true;
2069        // Visit the declaration name.
2070        if (VisitDeclarationNameInfo(O->getNameInfo()))
2071          return true;
2072        // Visit the overloaded declaration reference.
2073        if (Visit(MakeCursorOverloadedDeclRef(O, TU)))
2074          return true;
2075        continue;
2076      }
2077    }
2078  }
2079  return false;
2080}
2081
2082bool CursorVisitor::Visit(Stmt *S) {
2083  VisitorWorkList *WL = 0;
2084  if (!WorkListFreeList.empty()) {
2085    WL = WorkListFreeList.back();
2086    WL->clear();
2087    WorkListFreeList.pop_back();
2088  }
2089  else {
2090    WL = new VisitorWorkList();
2091    WorkListCache.push_back(WL);
2092  }
2093  EnqueueWorkList(*WL, S);
2094  bool result = RunVisitorWorkList(*WL);
2095  WorkListFreeList.push_back(WL);
2096  return result;
2097}
2098
2099//===----------------------------------------------------------------------===//
2100// Misc. API hooks.
2101//===----------------------------------------------------------------------===//
2102
2103static llvm::sys::Mutex EnableMultithreadingMutex;
2104static bool EnabledMultithreading;
2105
2106extern "C" {
2107CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
2108                          int displayDiagnostics) {
2109  // Disable pretty stack trace functionality, which will otherwise be a very
2110  // poor citizen of the world and set up all sorts of signal handlers.
2111  llvm::DisablePrettyStackTrace = true;
2112
2113  // We use crash recovery to make some of our APIs more reliable, implicitly
2114  // enable it.
2115  llvm::CrashRecoveryContext::Enable();
2116
2117  // Enable support for multithreading in LLVM.
2118  {
2119    llvm::sys::ScopedLock L(EnableMultithreadingMutex);
2120    if (!EnabledMultithreading) {
2121      llvm::llvm_start_multithreaded();
2122      EnabledMultithreading = true;
2123    }
2124  }
2125
2126  CIndexer *CIdxr = new CIndexer();
2127  if (excludeDeclarationsFromPCH)
2128    CIdxr->setOnlyLocalDecls();
2129  if (displayDiagnostics)
2130    CIdxr->setDisplayDiagnostics();
2131  return CIdxr;
2132}
2133
2134void clang_disposeIndex(CXIndex CIdx) {
2135  if (CIdx)
2136    delete static_cast<CIndexer *>(CIdx);
2137}
2138
2139CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
2140                                              const char *ast_filename) {
2141  if (!CIdx)
2142    return 0;
2143
2144  CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
2145  FileSystemOptions FileSystemOpts;
2146  FileSystemOpts.WorkingDir = CXXIdx->getWorkingDirectory();
2147
2148  llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
2149  ASTUnit *TU = ASTUnit::LoadFromASTFile(ast_filename, Diags, FileSystemOpts,
2150                                  CXXIdx->getOnlyLocalDecls(),
2151                                  0, 0, true);
2152  return MakeCXTranslationUnit(TU);
2153}
2154
2155unsigned clang_defaultEditingTranslationUnitOptions() {
2156  return CXTranslationUnit_PrecompiledPreamble |
2157         CXTranslationUnit_CacheCompletionResults |
2158         CXTranslationUnit_CXXPrecompiledPreamble;
2159}
2160
2161CXTranslationUnit
2162clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
2163                                          const char *source_filename,
2164                                          int num_command_line_args,
2165                                          const char * const *command_line_args,
2166                                          unsigned num_unsaved_files,
2167                                          struct CXUnsavedFile *unsaved_files) {
2168  return clang_parseTranslationUnit(CIdx, source_filename,
2169                                    command_line_args, num_command_line_args,
2170                                    unsaved_files, num_unsaved_files,
2171                                 CXTranslationUnit_DetailedPreprocessingRecord);
2172}
2173
2174struct ParseTranslationUnitInfo {
2175  CXIndex CIdx;
2176  const char *source_filename;
2177  const char *const *command_line_args;
2178  int num_command_line_args;
2179  struct CXUnsavedFile *unsaved_files;
2180  unsigned num_unsaved_files;
2181  unsigned options;
2182  CXTranslationUnit result;
2183};
2184static void clang_parseTranslationUnit_Impl(void *UserData) {
2185  ParseTranslationUnitInfo *PTUI =
2186    static_cast<ParseTranslationUnitInfo*>(UserData);
2187  CXIndex CIdx = PTUI->CIdx;
2188  const char *source_filename = PTUI->source_filename;
2189  const char * const *command_line_args = PTUI->command_line_args;
2190  int num_command_line_args = PTUI->num_command_line_args;
2191  struct CXUnsavedFile *unsaved_files = PTUI->unsaved_files;
2192  unsigned num_unsaved_files = PTUI->num_unsaved_files;
2193  unsigned options = PTUI->options;
2194  PTUI->result = 0;
2195
2196  if (!CIdx)
2197    return;
2198
2199  CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
2200
2201  bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
2202  bool CompleteTranslationUnit
2203    = ((options & CXTranslationUnit_Incomplete) == 0);
2204  bool CacheCodeCompetionResults
2205    = options & CXTranslationUnit_CacheCompletionResults;
2206  bool CXXPrecompilePreamble
2207    = options & CXTranslationUnit_CXXPrecompiledPreamble;
2208  bool CXXChainedPCH
2209    = options & CXTranslationUnit_CXXChainedPCH;
2210
2211  // Configure the diagnostics.
2212  DiagnosticOptions DiagOpts;
2213  llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
2214  Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
2215
2216  llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
2217  for (unsigned I = 0; I != num_unsaved_files; ++I) {
2218    llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
2219    const llvm::MemoryBuffer *Buffer
2220      = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
2221    RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2222                                           Buffer));
2223  }
2224
2225  llvm::SmallVector<const char *, 16> Args;
2226
2227  // The 'source_filename' argument is optional.  If the caller does not
2228  // specify it then it is assumed that the source file is specified
2229  // in the actual argument list.
2230  if (source_filename)
2231    Args.push_back(source_filename);
2232
2233  // Since the Clang C library is primarily used by batch tools dealing with
2234  // (often very broken) source code, where spell-checking can have a
2235  // significant negative impact on performance (particularly when
2236  // precompiled headers are involved), we disable it by default.
2237  // Only do this if we haven't found a spell-checking-related argument.
2238  bool FoundSpellCheckingArgument = false;
2239  for (int I = 0; I != num_command_line_args; ++I) {
2240    if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 ||
2241        strcmp(command_line_args[I], "-fspell-checking") == 0) {
2242      FoundSpellCheckingArgument = true;
2243      break;
2244    }
2245  }
2246  if (!FoundSpellCheckingArgument)
2247    Args.push_back("-fno-spell-checking");
2248
2249  Args.insert(Args.end(), command_line_args,
2250              command_line_args + num_command_line_args);
2251
2252  // Do we need the detailed preprocessing record?
2253  if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
2254    Args.push_back("-Xclang");
2255    Args.push_back("-detailed-preprocessing-record");
2256  }
2257
2258  unsigned NumErrors = Diags->getClient()->getNumErrors();
2259  llvm::OwningPtr<ASTUnit> Unit(
2260    ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(),
2261                                 Diags,
2262                                 CXXIdx->getClangResourcesPath(),
2263                                 CXXIdx->getOnlyLocalDecls(),
2264                                 /*CaptureDiagnostics=*/true,
2265                                 RemappedFiles.data(),
2266                                 RemappedFiles.size(),
2267                                 PrecompilePreamble,
2268                                 CompleteTranslationUnit,
2269                                 CacheCodeCompetionResults,
2270                                 CXXPrecompilePreamble,
2271                                 CXXChainedPCH));
2272
2273  if (NumErrors != Diags->getClient()->getNumErrors()) {
2274    // Make sure to check that 'Unit' is non-NULL.
2275    if (CXXIdx->getDisplayDiagnostics() && Unit.get()) {
2276      for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
2277                                      DEnd = Unit->stored_diag_end();
2278           D != DEnd; ++D) {
2279        CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions());
2280        CXString Msg = clang_formatDiagnostic(&Diag,
2281                                    clang_defaultDiagnosticDisplayOptions());
2282        fprintf(stderr, "%s\n", clang_getCString(Msg));
2283        clang_disposeString(Msg);
2284      }
2285#ifdef LLVM_ON_WIN32
2286      // On Windows, force a flush, since there may be multiple copies of
2287      // stderr and stdout in the file system, all with different buffers
2288      // but writing to the same device.
2289      fflush(stderr);
2290#endif
2291    }
2292  }
2293
2294  PTUI->result = MakeCXTranslationUnit(Unit.take());
2295}
2296CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx,
2297                                             const char *source_filename,
2298                                         const char * const *command_line_args,
2299                                             int num_command_line_args,
2300                                            struct CXUnsavedFile *unsaved_files,
2301                                             unsigned num_unsaved_files,
2302                                             unsigned options) {
2303  ParseTranslationUnitInfo PTUI = { CIdx, source_filename, command_line_args,
2304                                    num_command_line_args, unsaved_files,
2305                                    num_unsaved_files, options, 0 };
2306  llvm::CrashRecoveryContext CRC;
2307
2308  if (!RunSafely(CRC, clang_parseTranslationUnit_Impl, &PTUI)) {
2309    fprintf(stderr, "libclang: crash detected during parsing: {\n");
2310    fprintf(stderr, "  'source_filename' : '%s'\n", source_filename);
2311    fprintf(stderr, "  'command_line_args' : [");
2312    for (int i = 0; i != num_command_line_args; ++i) {
2313      if (i)
2314        fprintf(stderr, ", ");
2315      fprintf(stderr, "'%s'", command_line_args[i]);
2316    }
2317    fprintf(stderr, "],\n");
2318    fprintf(stderr, "  'unsaved_files' : [");
2319    for (unsigned i = 0; i != num_unsaved_files; ++i) {
2320      if (i)
2321        fprintf(stderr, ", ");
2322      fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
2323              unsaved_files[i].Length);
2324    }
2325    fprintf(stderr, "],\n");
2326    fprintf(stderr, "  'options' : %d,\n", options);
2327    fprintf(stderr, "}\n");
2328
2329    return 0;
2330  }
2331
2332  return PTUI.result;
2333}
2334
2335unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
2336  return CXSaveTranslationUnit_None;
2337}
2338
2339int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
2340                              unsigned options) {
2341  if (!TU)
2342    return 1;
2343
2344  return static_cast<ASTUnit *>(TU->TUData)->Save(FileName);
2345}
2346
2347void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
2348  if (CTUnit) {
2349    // If the translation unit has been marked as unsafe to free, just discard
2350    // it.
2351    if (static_cast<ASTUnit *>(CTUnit->TUData)->isUnsafeToFree())
2352      return;
2353
2354    delete static_cast<ASTUnit *>(CTUnit->TUData);
2355    disposeCXStringPool(CTUnit->StringPool);
2356    delete CTUnit;
2357  }
2358}
2359
2360unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
2361  return CXReparse_None;
2362}
2363
2364struct ReparseTranslationUnitInfo {
2365  CXTranslationUnit TU;
2366  unsigned num_unsaved_files;
2367  struct CXUnsavedFile *unsaved_files;
2368  unsigned options;
2369  int result;
2370};
2371
2372static void clang_reparseTranslationUnit_Impl(void *UserData) {
2373  ReparseTranslationUnitInfo *RTUI =
2374    static_cast<ReparseTranslationUnitInfo*>(UserData);
2375  CXTranslationUnit TU = RTUI->TU;
2376  unsigned num_unsaved_files = RTUI->num_unsaved_files;
2377  struct CXUnsavedFile *unsaved_files = RTUI->unsaved_files;
2378  unsigned options = RTUI->options;
2379  (void) options;
2380  RTUI->result = 1;
2381
2382  if (!TU)
2383    return;
2384
2385  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
2386  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
2387
2388  llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
2389  for (unsigned I = 0; I != num_unsaved_files; ++I) {
2390    llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
2391    const llvm::MemoryBuffer *Buffer
2392      = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
2393    RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2394                                           Buffer));
2395  }
2396
2397  if (!CXXUnit->Reparse(RemappedFiles.data(), RemappedFiles.size()))
2398    RTUI->result = 0;
2399}
2400
2401int clang_reparseTranslationUnit(CXTranslationUnit TU,
2402                                 unsigned num_unsaved_files,
2403                                 struct CXUnsavedFile *unsaved_files,
2404                                 unsigned options) {
2405  ReparseTranslationUnitInfo RTUI = { TU, num_unsaved_files, unsaved_files,
2406                                      options, 0 };
2407  llvm::CrashRecoveryContext CRC;
2408
2409  if (!RunSafely(CRC, clang_reparseTranslationUnit_Impl, &RTUI)) {
2410    fprintf(stderr, "libclang: crash detected during reparsing\n");
2411    static_cast<ASTUnit *>(TU->TUData)->setUnsafeToFree(true);
2412    return 1;
2413  }
2414
2415
2416  return RTUI.result;
2417}
2418
2419
2420CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
2421  if (!CTUnit)
2422    return createCXString("");
2423
2424  ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit->TUData);
2425  return createCXString(CXXUnit->getOriginalSourceFileName(), true);
2426}
2427
2428CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
2429  CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } };
2430  return Result;
2431}
2432
2433} // end: extern "C"
2434
2435//===----------------------------------------------------------------------===//
2436// CXSourceLocation and CXSourceRange Operations.
2437//===----------------------------------------------------------------------===//
2438
2439extern "C" {
2440CXSourceLocation clang_getNullLocation() {
2441  CXSourceLocation Result = { { 0, 0 }, 0 };
2442  return Result;
2443}
2444
2445unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) {
2446  return (loc1.ptr_data[0] == loc2.ptr_data[0] &&
2447          loc1.ptr_data[1] == loc2.ptr_data[1] &&
2448          loc1.int_data == loc2.int_data);
2449}
2450
2451CXSourceLocation clang_getLocation(CXTranslationUnit tu,
2452                                   CXFile file,
2453                                   unsigned line,
2454                                   unsigned column) {
2455  if (!tu || !file)
2456    return clang_getNullLocation();
2457
2458  ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
2459  SourceLocation SLoc
2460    = CXXUnit->getSourceManager().getLocation(
2461                                        static_cast<const FileEntry *>(file),
2462                                              line, column);
2463  if (SLoc.isInvalid()) return clang_getNullLocation();
2464
2465  return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
2466}
2467
2468CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
2469                                            CXFile file,
2470                                            unsigned offset) {
2471  if (!tu || !file)
2472    return clang_getNullLocation();
2473
2474  ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
2475  SourceLocation Start
2476    = CXXUnit->getSourceManager().getLocation(
2477                                        static_cast<const FileEntry *>(file),
2478                                              1, 1);
2479  if (Start.isInvalid()) return clang_getNullLocation();
2480
2481  SourceLocation SLoc = Start.getFileLocWithOffset(offset);
2482
2483  if (SLoc.isInvalid()) return clang_getNullLocation();
2484
2485  return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
2486}
2487
2488CXSourceRange clang_getNullRange() {
2489  CXSourceRange Result = { { 0, 0 }, 0, 0 };
2490  return Result;
2491}
2492
2493CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) {
2494  if (begin.ptr_data[0] != end.ptr_data[0] ||
2495      begin.ptr_data[1] != end.ptr_data[1])
2496    return clang_getNullRange();
2497
2498  CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] },
2499                           begin.int_data, end.int_data };
2500  return Result;
2501}
2502
2503void clang_getInstantiationLocation(CXSourceLocation location,
2504                                    CXFile *file,
2505                                    unsigned *line,
2506                                    unsigned *column,
2507                                    unsigned *offset) {
2508  SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2509
2510  if (!location.ptr_data[0] || Loc.isInvalid()) {
2511    if (file)
2512      *file = 0;
2513    if (line)
2514      *line = 0;
2515    if (column)
2516      *column = 0;
2517    if (offset)
2518      *offset = 0;
2519    return;
2520  }
2521
2522  const SourceManager &SM =
2523    *static_cast<const SourceManager*>(location.ptr_data[0]);
2524  SourceLocation InstLoc = SM.getInstantiationLoc(Loc);
2525
2526  if (file)
2527    *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc));
2528  if (line)
2529    *line = SM.getInstantiationLineNumber(InstLoc);
2530  if (column)
2531    *column = SM.getInstantiationColumnNumber(InstLoc);
2532  if (offset)
2533    *offset = SM.getDecomposedLoc(InstLoc).second;
2534}
2535
2536void clang_getSpellingLocation(CXSourceLocation location,
2537                               CXFile *file,
2538                               unsigned *line,
2539                               unsigned *column,
2540                               unsigned *offset) {
2541  SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2542
2543  if (!location.ptr_data[0] || Loc.isInvalid()) {
2544    if (file)
2545      *file = 0;
2546    if (line)
2547      *line = 0;
2548    if (column)
2549      *column = 0;
2550    if (offset)
2551      *offset = 0;
2552    return;
2553  }
2554
2555  const SourceManager &SM =
2556    *static_cast<const SourceManager*>(location.ptr_data[0]);
2557  SourceLocation SpellLoc = Loc;
2558  if (SpellLoc.isMacroID()) {
2559    SourceLocation SimpleSpellingLoc = SM.getImmediateSpellingLoc(SpellLoc);
2560    if (SimpleSpellingLoc.isFileID() &&
2561        SM.getFileEntryForID(SM.getDecomposedLoc(SimpleSpellingLoc).first))
2562      SpellLoc = SimpleSpellingLoc;
2563    else
2564      SpellLoc = SM.getInstantiationLoc(SpellLoc);
2565  }
2566
2567  std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(SpellLoc);
2568  FileID FID = LocInfo.first;
2569  unsigned FileOffset = LocInfo.second;
2570
2571  if (file)
2572    *file = (void *)SM.getFileEntryForID(FID);
2573  if (line)
2574    *line = SM.getLineNumber(FID, FileOffset);
2575  if (column)
2576    *column = SM.getColumnNumber(FID, FileOffset);
2577  if (offset)
2578    *offset = FileOffset;
2579}
2580
2581CXSourceLocation clang_getRangeStart(CXSourceRange range) {
2582  CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
2583                              range.begin_int_data };
2584  return Result;
2585}
2586
2587CXSourceLocation clang_getRangeEnd(CXSourceRange range) {
2588  CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
2589                              range.end_int_data };
2590  return Result;
2591}
2592
2593} // end: extern "C"
2594
2595//===----------------------------------------------------------------------===//
2596// CXFile Operations.
2597//===----------------------------------------------------------------------===//
2598
2599extern "C" {
2600CXString clang_getFileName(CXFile SFile) {
2601  if (!SFile)
2602    return createCXString((const char*)NULL);
2603
2604  FileEntry *FEnt = static_cast<FileEntry *>(SFile);
2605  return createCXString(FEnt->getName());
2606}
2607
2608time_t clang_getFileTime(CXFile SFile) {
2609  if (!SFile)
2610    return 0;
2611
2612  FileEntry *FEnt = static_cast<FileEntry *>(SFile);
2613  return FEnt->getModificationTime();
2614}
2615
2616CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) {
2617  if (!tu)
2618    return 0;
2619
2620  ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
2621
2622  FileManager &FMgr = CXXUnit->getFileManager();
2623  return const_cast<FileEntry *>(FMgr.getFile(file_name));
2624}
2625
2626} // end: extern "C"
2627
2628//===----------------------------------------------------------------------===//
2629// CXCursor Operations.
2630//===----------------------------------------------------------------------===//
2631
2632static Decl *getDeclFromExpr(Stmt *E) {
2633  if (CastExpr *CE = dyn_cast<CastExpr>(E))
2634    return getDeclFromExpr(CE->getSubExpr());
2635
2636  if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
2637    return RefExpr->getDecl();
2638  if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
2639    return RefExpr->getDecl();
2640  if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
2641    return ME->getMemberDecl();
2642  if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
2643    return RE->getDecl();
2644  if (ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E))
2645    return PRE->isExplicitProperty() ? PRE->getExplicitProperty() : 0;
2646
2647  if (CallExpr *CE = dyn_cast<CallExpr>(E))
2648    return getDeclFromExpr(CE->getCallee());
2649  if (CXXConstructExpr *CE = llvm::dyn_cast<CXXConstructExpr>(E))
2650    if (!CE->isElidable())
2651    return CE->getConstructor();
2652  if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
2653    return OME->getMethodDecl();
2654
2655  if (ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E))
2656    return PE->getProtocol();
2657  if (SubstNonTypeTemplateParmPackExpr *NTTP
2658                              = dyn_cast<SubstNonTypeTemplateParmPackExpr>(E))
2659    return NTTP->getParameterPack();
2660
2661  return 0;
2662}
2663
2664static SourceLocation getLocationFromExpr(Expr *E) {
2665  if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
2666    return /*FIXME:*/Msg->getLeftLoc();
2667  if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
2668    return DRE->getLocation();
2669  if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
2670    return RefExpr->getLocation();
2671  if (MemberExpr *Member = dyn_cast<MemberExpr>(E))
2672    return Member->getMemberLoc();
2673  if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
2674    return Ivar->getLocation();
2675  return E->getLocStart();
2676}
2677
2678extern "C" {
2679
2680unsigned clang_visitChildren(CXCursor parent,
2681                             CXCursorVisitor visitor,
2682                             CXClientData client_data) {
2683  CursorVisitor CursorVis(getCursorTU(parent), visitor, client_data,
2684                          getCursorASTUnit(parent)->getMaxPCHLevel());
2685  return CursorVis.VisitChildren(parent);
2686}
2687
2688#ifndef __has_feature
2689#define __has_feature(x) 0
2690#endif
2691#if __has_feature(blocks)
2692typedef enum CXChildVisitResult
2693     (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
2694
2695static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
2696    CXClientData client_data) {
2697  CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
2698  return block(cursor, parent);
2699}
2700#else
2701// If we are compiled with a compiler that doesn't have native blocks support,
2702// define and call the block manually, so the
2703typedef struct _CXChildVisitResult
2704{
2705	void *isa;
2706	int flags;
2707	int reserved;
2708	enum CXChildVisitResult(*invoke)(struct _CXChildVisitResult*, CXCursor,
2709                                         CXCursor);
2710} *CXCursorVisitorBlock;
2711
2712static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
2713    CXClientData client_data) {
2714  CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
2715  return block->invoke(block, cursor, parent);
2716}
2717#endif
2718
2719
2720unsigned clang_visitChildrenWithBlock(CXCursor parent,
2721                                      CXCursorVisitorBlock block) {
2722  return clang_visitChildren(parent, visitWithBlock, block);
2723}
2724
2725static CXString getDeclSpelling(Decl *D) {
2726  NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D);
2727  if (!ND) {
2728    if (ObjCPropertyImplDecl *PropImpl =llvm::dyn_cast<ObjCPropertyImplDecl>(D))
2729      if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
2730        return createCXString(Property->getIdentifier()->getName());
2731
2732    return createCXString("");
2733  }
2734
2735  if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
2736    return createCXString(OMD->getSelector().getAsString());
2737
2738  if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
2739    // No, this isn't the same as the code below. getIdentifier() is non-virtual
2740    // and returns different names. NamedDecl returns the class name and
2741    // ObjCCategoryImplDecl returns the category name.
2742    return createCXString(CIMP->getIdentifier()->getNameStart());
2743
2744  if (isa<UsingDirectiveDecl>(D))
2745    return createCXString("");
2746
2747  llvm::SmallString<1024> S;
2748  llvm::raw_svector_ostream os(S);
2749  ND->printName(os);
2750
2751  return createCXString(os.str());
2752}
2753
2754CXString clang_getCursorSpelling(CXCursor C) {
2755  if (clang_isTranslationUnit(C.kind))
2756    return clang_getTranslationUnitSpelling(
2757                            static_cast<CXTranslationUnit>(C.data[2]));
2758
2759  if (clang_isReference(C.kind)) {
2760    switch (C.kind) {
2761    case CXCursor_ObjCSuperClassRef: {
2762      ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
2763      return createCXString(Super->getIdentifier()->getNameStart());
2764    }
2765    case CXCursor_ObjCClassRef: {
2766      ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
2767      return createCXString(Class->getIdentifier()->getNameStart());
2768    }
2769    case CXCursor_ObjCProtocolRef: {
2770      ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
2771      assert(OID && "getCursorSpelling(): Missing protocol decl");
2772      return createCXString(OID->getIdentifier()->getNameStart());
2773    }
2774    case CXCursor_CXXBaseSpecifier: {
2775      CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
2776      return createCXString(B->getType().getAsString());
2777    }
2778    case CXCursor_TypeRef: {
2779      TypeDecl *Type = getCursorTypeRef(C).first;
2780      assert(Type && "Missing type decl");
2781
2782      return createCXString(getCursorContext(C).getTypeDeclType(Type).
2783                              getAsString());
2784    }
2785    case CXCursor_TemplateRef: {
2786      TemplateDecl *Template = getCursorTemplateRef(C).first;
2787      assert(Template && "Missing template decl");
2788
2789      return createCXString(Template->getNameAsString());
2790    }
2791
2792    case CXCursor_NamespaceRef: {
2793      NamedDecl *NS = getCursorNamespaceRef(C).first;
2794      assert(NS && "Missing namespace decl");
2795
2796      return createCXString(NS->getNameAsString());
2797    }
2798
2799    case CXCursor_MemberRef: {
2800      FieldDecl *Field = getCursorMemberRef(C).first;
2801      assert(Field && "Missing member decl");
2802
2803      return createCXString(Field->getNameAsString());
2804    }
2805
2806    case CXCursor_LabelRef: {
2807      LabelStmt *Label = getCursorLabelRef(C).first;
2808      assert(Label && "Missing label");
2809
2810      return createCXString(Label->getID()->getName());
2811    }
2812
2813    case CXCursor_OverloadedDeclRef: {
2814      OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
2815      if (Decl *D = Storage.dyn_cast<Decl *>()) {
2816        if (NamedDecl *ND = dyn_cast<NamedDecl>(D))
2817          return createCXString(ND->getNameAsString());
2818        return createCXString("");
2819      }
2820      if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
2821        return createCXString(E->getName().getAsString());
2822      OverloadedTemplateStorage *Ovl
2823        = Storage.get<OverloadedTemplateStorage*>();
2824      if (Ovl->size() == 0)
2825        return createCXString("");
2826      return createCXString((*Ovl->begin())->getNameAsString());
2827    }
2828
2829    default:
2830      return createCXString("<not implemented>");
2831    }
2832  }
2833
2834  if (clang_isExpression(C.kind)) {
2835    Decl *D = getDeclFromExpr(getCursorExpr(C));
2836    if (D)
2837      return getDeclSpelling(D);
2838    return createCXString("");
2839  }
2840
2841  if (clang_isStatement(C.kind)) {
2842    Stmt *S = getCursorStmt(C);
2843    if (LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S))
2844      return createCXString(Label->getID()->getName());
2845
2846    return createCXString("");
2847  }
2848
2849  if (C.kind == CXCursor_MacroInstantiation)
2850    return createCXString(getCursorMacroInstantiation(C)->getName()
2851                                                           ->getNameStart());
2852
2853  if (C.kind == CXCursor_MacroDefinition)
2854    return createCXString(getCursorMacroDefinition(C)->getName()
2855                                                           ->getNameStart());
2856
2857  if (C.kind == CXCursor_InclusionDirective)
2858    return createCXString(getCursorInclusionDirective(C)->getFileName());
2859
2860  if (clang_isDeclaration(C.kind))
2861    return getDeclSpelling(getCursorDecl(C));
2862
2863  return createCXString("");
2864}
2865
2866CXString clang_getCursorDisplayName(CXCursor C) {
2867  if (!clang_isDeclaration(C.kind))
2868    return clang_getCursorSpelling(C);
2869
2870  Decl *D = getCursorDecl(C);
2871  if (!D)
2872    return createCXString("");
2873
2874  PrintingPolicy &Policy = getCursorContext(C).PrintingPolicy;
2875  if (FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D))
2876    D = FunTmpl->getTemplatedDecl();
2877
2878  if (FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
2879    llvm::SmallString<64> Str;
2880    llvm::raw_svector_ostream OS(Str);
2881    OS << Function->getNameAsString();
2882    if (Function->getPrimaryTemplate())
2883      OS << "<>";
2884    OS << "(";
2885    for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) {
2886      if (I)
2887        OS << ", ";
2888      OS << Function->getParamDecl(I)->getType().getAsString(Policy);
2889    }
2890
2891    if (Function->isVariadic()) {
2892      if (Function->getNumParams())
2893        OS << ", ";
2894      OS << "...";
2895    }
2896    OS << ")";
2897    return createCXString(OS.str());
2898  }
2899
2900  if (ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) {
2901    llvm::SmallString<64> Str;
2902    llvm::raw_svector_ostream OS(Str);
2903    OS << ClassTemplate->getNameAsString();
2904    OS << "<";
2905    TemplateParameterList *Params = ClassTemplate->getTemplateParameters();
2906    for (unsigned I = 0, N = Params->size(); I != N; ++I) {
2907      if (I)
2908        OS << ", ";
2909
2910      NamedDecl *Param = Params->getParam(I);
2911      if (Param->getIdentifier()) {
2912        OS << Param->getIdentifier()->getName();
2913        continue;
2914      }
2915
2916      // There is no parameter name, which makes this tricky. Try to come up
2917      // with something useful that isn't too long.
2918      if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
2919        OS << (TTP->wasDeclaredWithTypename()? "typename" : "class");
2920      else if (NonTypeTemplateParmDecl *NTTP
2921                                    = dyn_cast<NonTypeTemplateParmDecl>(Param))
2922        OS << NTTP->getType().getAsString(Policy);
2923      else
2924        OS << "template<...> class";
2925    }
2926
2927    OS << ">";
2928    return createCXString(OS.str());
2929  }
2930
2931  if (ClassTemplateSpecializationDecl *ClassSpec
2932                              = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
2933    // If the type was explicitly written, use that.
2934    if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten())
2935      return createCXString(TSInfo->getType().getAsString(Policy));
2936
2937    llvm::SmallString<64> Str;
2938    llvm::raw_svector_ostream OS(Str);
2939    OS << ClassSpec->getNameAsString();
2940    OS << TemplateSpecializationType::PrintTemplateArgumentList(
2941                                      ClassSpec->getTemplateArgs().data(),
2942                                      ClassSpec->getTemplateArgs().size(),
2943                                                                Policy);
2944    return createCXString(OS.str());
2945  }
2946
2947  return clang_getCursorSpelling(C);
2948}
2949
2950CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
2951  switch (Kind) {
2952  case CXCursor_FunctionDecl:
2953      return createCXString("FunctionDecl");
2954  case CXCursor_TypedefDecl:
2955      return createCXString("TypedefDecl");
2956  case CXCursor_EnumDecl:
2957      return createCXString("EnumDecl");
2958  case CXCursor_EnumConstantDecl:
2959      return createCXString("EnumConstantDecl");
2960  case CXCursor_StructDecl:
2961      return createCXString("StructDecl");
2962  case CXCursor_UnionDecl:
2963      return createCXString("UnionDecl");
2964  case CXCursor_ClassDecl:
2965      return createCXString("ClassDecl");
2966  case CXCursor_FieldDecl:
2967      return createCXString("FieldDecl");
2968  case CXCursor_VarDecl:
2969      return createCXString("VarDecl");
2970  case CXCursor_ParmDecl:
2971      return createCXString("ParmDecl");
2972  case CXCursor_ObjCInterfaceDecl:
2973      return createCXString("ObjCInterfaceDecl");
2974  case CXCursor_ObjCCategoryDecl:
2975      return createCXString("ObjCCategoryDecl");
2976  case CXCursor_ObjCProtocolDecl:
2977      return createCXString("ObjCProtocolDecl");
2978  case CXCursor_ObjCPropertyDecl:
2979      return createCXString("ObjCPropertyDecl");
2980  case CXCursor_ObjCIvarDecl:
2981      return createCXString("ObjCIvarDecl");
2982  case CXCursor_ObjCInstanceMethodDecl:
2983      return createCXString("ObjCInstanceMethodDecl");
2984  case CXCursor_ObjCClassMethodDecl:
2985      return createCXString("ObjCClassMethodDecl");
2986  case CXCursor_ObjCImplementationDecl:
2987      return createCXString("ObjCImplementationDecl");
2988  case CXCursor_ObjCCategoryImplDecl:
2989      return createCXString("ObjCCategoryImplDecl");
2990  case CXCursor_CXXMethod:
2991      return createCXString("CXXMethod");
2992  case CXCursor_UnexposedDecl:
2993      return createCXString("UnexposedDecl");
2994  case CXCursor_ObjCSuperClassRef:
2995      return createCXString("ObjCSuperClassRef");
2996  case CXCursor_ObjCProtocolRef:
2997      return createCXString("ObjCProtocolRef");
2998  case CXCursor_ObjCClassRef:
2999      return createCXString("ObjCClassRef");
3000  case CXCursor_TypeRef:
3001      return createCXString("TypeRef");
3002  case CXCursor_TemplateRef:
3003      return createCXString("TemplateRef");
3004  case CXCursor_NamespaceRef:
3005    return createCXString("NamespaceRef");
3006  case CXCursor_MemberRef:
3007    return createCXString("MemberRef");
3008  case CXCursor_LabelRef:
3009    return createCXString("LabelRef");
3010  case CXCursor_OverloadedDeclRef:
3011    return createCXString("OverloadedDeclRef");
3012  case CXCursor_UnexposedExpr:
3013      return createCXString("UnexposedExpr");
3014  case CXCursor_BlockExpr:
3015      return createCXString("BlockExpr");
3016  case CXCursor_DeclRefExpr:
3017      return createCXString("DeclRefExpr");
3018  case CXCursor_MemberRefExpr:
3019      return createCXString("MemberRefExpr");
3020  case CXCursor_CallExpr:
3021      return createCXString("CallExpr");
3022  case CXCursor_ObjCMessageExpr:
3023      return createCXString("ObjCMessageExpr");
3024  case CXCursor_UnexposedStmt:
3025      return createCXString("UnexposedStmt");
3026  case CXCursor_LabelStmt:
3027      return createCXString("LabelStmt");
3028  case CXCursor_InvalidFile:
3029      return createCXString("InvalidFile");
3030  case CXCursor_InvalidCode:
3031    return createCXString("InvalidCode");
3032  case CXCursor_NoDeclFound:
3033      return createCXString("NoDeclFound");
3034  case CXCursor_NotImplemented:
3035      return createCXString("NotImplemented");
3036  case CXCursor_TranslationUnit:
3037      return createCXString("TranslationUnit");
3038  case CXCursor_UnexposedAttr:
3039      return createCXString("UnexposedAttr");
3040  case CXCursor_IBActionAttr:
3041      return createCXString("attribute(ibaction)");
3042  case CXCursor_IBOutletAttr:
3043     return createCXString("attribute(iboutlet)");
3044  case CXCursor_IBOutletCollectionAttr:
3045      return createCXString("attribute(iboutletcollection)");
3046  case CXCursor_PreprocessingDirective:
3047    return createCXString("preprocessing directive");
3048  case CXCursor_MacroDefinition:
3049    return createCXString("macro definition");
3050  case CXCursor_MacroInstantiation:
3051    return createCXString("macro instantiation");
3052  case CXCursor_InclusionDirective:
3053    return createCXString("inclusion directive");
3054  case CXCursor_Namespace:
3055    return createCXString("Namespace");
3056  case CXCursor_LinkageSpec:
3057    return createCXString("LinkageSpec");
3058  case CXCursor_CXXBaseSpecifier:
3059    return createCXString("C++ base class specifier");
3060  case CXCursor_Constructor:
3061    return createCXString("CXXConstructor");
3062  case CXCursor_Destructor:
3063    return createCXString("CXXDestructor");
3064  case CXCursor_ConversionFunction:
3065    return createCXString("CXXConversion");
3066  case CXCursor_TemplateTypeParameter:
3067    return createCXString("TemplateTypeParameter");
3068  case CXCursor_NonTypeTemplateParameter:
3069    return createCXString("NonTypeTemplateParameter");
3070  case CXCursor_TemplateTemplateParameter:
3071    return createCXString("TemplateTemplateParameter");
3072  case CXCursor_FunctionTemplate:
3073    return createCXString("FunctionTemplate");
3074  case CXCursor_ClassTemplate:
3075    return createCXString("ClassTemplate");
3076  case CXCursor_ClassTemplatePartialSpecialization:
3077    return createCXString("ClassTemplatePartialSpecialization");
3078  case CXCursor_NamespaceAlias:
3079    return createCXString("NamespaceAlias");
3080  case CXCursor_UsingDirective:
3081    return createCXString("UsingDirective");
3082  case CXCursor_UsingDeclaration:
3083    return createCXString("UsingDeclaration");
3084  }
3085
3086  llvm_unreachable("Unhandled CXCursorKind");
3087  return createCXString((const char*) 0);
3088}
3089
3090enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
3091                                         CXCursor parent,
3092                                         CXClientData client_data) {
3093  CXCursor *BestCursor = static_cast<CXCursor *>(client_data);
3094
3095  // If our current best cursor is the construction of a temporary object,
3096  // don't replace that cursor with a type reference, because we want
3097  // clang_getCursor() to point at the constructor.
3098  if (clang_isExpression(BestCursor->kind) &&
3099      isa<CXXTemporaryObjectExpr>(getCursorExpr(*BestCursor)) &&
3100      cursor.kind == CXCursor_TypeRef)
3101    return CXChildVisit_Recurse;
3102
3103  // Don't override a preprocessing cursor with another preprocessing
3104  // cursor; we want the outermost preprocessing cursor.
3105  if (clang_isPreprocessing(cursor.kind) &&
3106      clang_isPreprocessing(BestCursor->kind))
3107    return CXChildVisit_Recurse;
3108
3109  *BestCursor = cursor;
3110  return CXChildVisit_Recurse;
3111}
3112
3113CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
3114  if (!TU)
3115    return clang_getNullCursor();
3116
3117  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
3118  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3119
3120  // Translate the given source location to make it point at the beginning of
3121  // the token under the cursor.
3122  SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
3123
3124  // Guard against an invalid SourceLocation, or we may assert in one
3125  // of the following calls.
3126  if (SLoc.isInvalid())
3127    return clang_getNullCursor();
3128
3129  bool Logging = getenv("LIBCLANG_LOGGING");
3130  SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
3131                                    CXXUnit->getASTContext().getLangOptions());
3132
3133  CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
3134  if (SLoc.isValid()) {
3135    // FIXME: Would be great to have a "hint" cursor, then walk from that
3136    // hint cursor upward until we find a cursor whose source range encloses
3137    // the region of interest, rather than starting from the translation unit.
3138    CXCursor Parent = clang_getTranslationUnitCursor(TU);
3139    CursorVisitor CursorVis(TU, GetCursorVisitor, &Result,
3140                            Decl::MaxPCHLevel, SourceLocation(SLoc));
3141    CursorVis.VisitChildren(Parent);
3142  }
3143
3144  if (Logging) {
3145    CXFile SearchFile;
3146    unsigned SearchLine, SearchColumn;
3147    CXFile ResultFile;
3148    unsigned ResultLine, ResultColumn;
3149    CXString SearchFileName, ResultFileName, KindSpelling, USR;
3150    const char *IsDef = clang_isCursorDefinition(Result)? " (Definition)" : "";
3151    CXSourceLocation ResultLoc = clang_getCursorLocation(Result);
3152
3153    clang_getInstantiationLocation(Loc, &SearchFile, &SearchLine, &SearchColumn,
3154                                   0);
3155    clang_getInstantiationLocation(ResultLoc, &ResultFile, &ResultLine,
3156                                   &ResultColumn, 0);
3157    SearchFileName = clang_getFileName(SearchFile);
3158    ResultFileName = clang_getFileName(ResultFile);
3159    KindSpelling = clang_getCursorKindSpelling(Result.kind);
3160    USR = clang_getCursorUSR(Result);
3161    fprintf(stderr, "clang_getCursor(%s:%d:%d) = %s(%s:%d:%d):%s%s\n",
3162            clang_getCString(SearchFileName), SearchLine, SearchColumn,
3163            clang_getCString(KindSpelling),
3164            clang_getCString(ResultFileName), ResultLine, ResultColumn,
3165            clang_getCString(USR), IsDef);
3166    clang_disposeString(SearchFileName);
3167    clang_disposeString(ResultFileName);
3168    clang_disposeString(KindSpelling);
3169    clang_disposeString(USR);
3170
3171    CXCursor Definition = clang_getCursorDefinition(Result);
3172    if (!clang_equalCursors(Definition, clang_getNullCursor())) {
3173      CXSourceLocation DefinitionLoc = clang_getCursorLocation(Definition);
3174      CXString DefinitionKindSpelling
3175                                = clang_getCursorKindSpelling(Definition.kind);
3176      CXFile DefinitionFile;
3177      unsigned DefinitionLine, DefinitionColumn;
3178      clang_getInstantiationLocation(DefinitionLoc, &DefinitionFile,
3179                                     &DefinitionLine, &DefinitionColumn, 0);
3180      CXString DefinitionFileName = clang_getFileName(DefinitionFile);
3181      fprintf(stderr, "  -> %s(%s:%d:%d)\n",
3182              clang_getCString(DefinitionKindSpelling),
3183              clang_getCString(DefinitionFileName),
3184              DefinitionLine, DefinitionColumn);
3185      clang_disposeString(DefinitionFileName);
3186      clang_disposeString(DefinitionKindSpelling);
3187    }
3188  }
3189
3190  return Result;
3191}
3192
3193CXCursor clang_getNullCursor(void) {
3194  return MakeCXCursorInvalid(CXCursor_InvalidFile);
3195}
3196
3197unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
3198  return X == Y;
3199}
3200
3201unsigned clang_hashCursor(CXCursor C) {
3202  unsigned Index = 0;
3203  if (clang_isExpression(C.kind) || clang_isStatement(C.kind))
3204    Index = 1;
3205
3206  return llvm::DenseMapInfo<std::pair<unsigned, void*> >::getHashValue(
3207                                        std::make_pair(C.kind, C.data[Index]));
3208}
3209
3210unsigned clang_isInvalid(enum CXCursorKind K) {
3211  return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
3212}
3213
3214unsigned clang_isDeclaration(enum CXCursorKind K) {
3215  return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
3216}
3217
3218unsigned clang_isReference(enum CXCursorKind K) {
3219  return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
3220}
3221
3222unsigned clang_isExpression(enum CXCursorKind K) {
3223  return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
3224}
3225
3226unsigned clang_isStatement(enum CXCursorKind K) {
3227  return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
3228}
3229
3230unsigned clang_isTranslationUnit(enum CXCursorKind K) {
3231  return K == CXCursor_TranslationUnit;
3232}
3233
3234unsigned clang_isPreprocessing(enum CXCursorKind K) {
3235  return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
3236}
3237
3238unsigned clang_isUnexposed(enum CXCursorKind K) {
3239  switch (K) {
3240    case CXCursor_UnexposedDecl:
3241    case CXCursor_UnexposedExpr:
3242    case CXCursor_UnexposedStmt:
3243    case CXCursor_UnexposedAttr:
3244      return true;
3245    default:
3246      return false;
3247  }
3248}
3249
3250CXCursorKind clang_getCursorKind(CXCursor C) {
3251  return C.kind;
3252}
3253
3254CXSourceLocation clang_getCursorLocation(CXCursor C) {
3255  if (clang_isReference(C.kind)) {
3256    switch (C.kind) {
3257    case CXCursor_ObjCSuperClassRef: {
3258      std::pair<ObjCInterfaceDecl *, SourceLocation> P
3259        = getCursorObjCSuperClassRef(C);
3260      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3261    }
3262
3263    case CXCursor_ObjCProtocolRef: {
3264      std::pair<ObjCProtocolDecl *, SourceLocation> P
3265        = getCursorObjCProtocolRef(C);
3266      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3267    }
3268
3269    case CXCursor_ObjCClassRef: {
3270      std::pair<ObjCInterfaceDecl *, SourceLocation> P
3271        = getCursorObjCClassRef(C);
3272      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3273    }
3274
3275    case CXCursor_TypeRef: {
3276      std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
3277      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3278    }
3279
3280    case CXCursor_TemplateRef: {
3281      std::pair<TemplateDecl *, SourceLocation> P = getCursorTemplateRef(C);
3282      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3283    }
3284
3285    case CXCursor_NamespaceRef: {
3286      std::pair<NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
3287      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3288    }
3289
3290    case CXCursor_MemberRef: {
3291      std::pair<FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
3292      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3293    }
3294
3295    case CXCursor_CXXBaseSpecifier: {
3296      CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C);
3297      if (!BaseSpec)
3298        return clang_getNullLocation();
3299
3300      if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo())
3301        return cxloc::translateSourceLocation(getCursorContext(C),
3302                                            TSInfo->getTypeLoc().getBeginLoc());
3303
3304      return cxloc::translateSourceLocation(getCursorContext(C),
3305                                        BaseSpec->getSourceRange().getBegin());
3306    }
3307
3308    case CXCursor_LabelRef: {
3309      std::pair<LabelStmt *, SourceLocation> P = getCursorLabelRef(C);
3310      return cxloc::translateSourceLocation(getCursorContext(C), P.second);
3311    }
3312
3313    case CXCursor_OverloadedDeclRef:
3314      return cxloc::translateSourceLocation(getCursorContext(C),
3315                                          getCursorOverloadedDeclRef(C).second);
3316
3317    default:
3318      // FIXME: Need a way to enumerate all non-reference cases.
3319      llvm_unreachable("Missed a reference kind");
3320    }
3321  }
3322
3323  if (clang_isExpression(C.kind))
3324    return cxloc::translateSourceLocation(getCursorContext(C),
3325                                   getLocationFromExpr(getCursorExpr(C)));
3326
3327  if (clang_isStatement(C.kind))
3328    return cxloc::translateSourceLocation(getCursorContext(C),
3329                                          getCursorStmt(C)->getLocStart());
3330
3331  if (C.kind == CXCursor_PreprocessingDirective) {
3332    SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
3333    return cxloc::translateSourceLocation(getCursorContext(C), L);
3334  }
3335
3336  if (C.kind == CXCursor_MacroInstantiation) {
3337    SourceLocation L
3338      = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin();
3339    return cxloc::translateSourceLocation(getCursorContext(C), L);
3340  }
3341
3342  if (C.kind == CXCursor_MacroDefinition) {
3343    SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
3344    return cxloc::translateSourceLocation(getCursorContext(C), L);
3345  }
3346
3347  if (C.kind == CXCursor_InclusionDirective) {
3348    SourceLocation L
3349      = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin();
3350    return cxloc::translateSourceLocation(getCursorContext(C), L);
3351  }
3352
3353  if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
3354    return clang_getNullLocation();
3355
3356  Decl *D = getCursorDecl(C);
3357  SourceLocation Loc = D->getLocation();
3358  if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D))
3359    Loc = Class->getClassLoc();
3360  // FIXME: Multiple variables declared in a single declaration
3361  // currently lack the information needed to correctly determine their
3362  // ranges when accounting for the type-specifier.  We use context
3363  // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3364  // and if so, whether it is the first decl.
3365  if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3366    if (!cxcursor::isFirstInDeclGroup(C))
3367      Loc = VD->getLocation();
3368  }
3369
3370  return cxloc::translateSourceLocation(getCursorContext(C), Loc);
3371}
3372
3373} // end extern "C"
3374
3375static SourceRange getRawCursorExtent(CXCursor C) {
3376  if (clang_isReference(C.kind)) {
3377    switch (C.kind) {
3378    case CXCursor_ObjCSuperClassRef:
3379      return  getCursorObjCSuperClassRef(C).second;
3380
3381    case CXCursor_ObjCProtocolRef:
3382      return getCursorObjCProtocolRef(C).second;
3383
3384    case CXCursor_ObjCClassRef:
3385      return getCursorObjCClassRef(C).second;
3386
3387    case CXCursor_TypeRef:
3388      return getCursorTypeRef(C).second;
3389
3390    case CXCursor_TemplateRef:
3391      return getCursorTemplateRef(C).second;
3392
3393    case CXCursor_NamespaceRef:
3394      return getCursorNamespaceRef(C).second;
3395
3396    case CXCursor_MemberRef:
3397      return getCursorMemberRef(C).second;
3398
3399    case CXCursor_CXXBaseSpecifier:
3400      return getCursorCXXBaseSpecifier(C)->getSourceRange();
3401
3402    case CXCursor_LabelRef:
3403      return getCursorLabelRef(C).second;
3404
3405    case CXCursor_OverloadedDeclRef:
3406      return getCursorOverloadedDeclRef(C).second;
3407
3408    default:
3409      // FIXME: Need a way to enumerate all non-reference cases.
3410      llvm_unreachable("Missed a reference kind");
3411    }
3412  }
3413
3414  if (clang_isExpression(C.kind))
3415    return getCursorExpr(C)->getSourceRange();
3416
3417  if (clang_isStatement(C.kind))
3418    return getCursorStmt(C)->getSourceRange();
3419
3420  if (C.kind == CXCursor_PreprocessingDirective)
3421    return cxcursor::getCursorPreprocessingDirective(C);
3422
3423  if (C.kind == CXCursor_MacroInstantiation)
3424    return cxcursor::getCursorMacroInstantiation(C)->getSourceRange();
3425
3426  if (C.kind == CXCursor_MacroDefinition)
3427    return cxcursor::getCursorMacroDefinition(C)->getSourceRange();
3428
3429  if (C.kind == CXCursor_InclusionDirective)
3430    return cxcursor::getCursorInclusionDirective(C)->getSourceRange();
3431
3432  if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl) {
3433    Decl *D = cxcursor::getCursorDecl(C);
3434    SourceRange R = D->getSourceRange();
3435    // FIXME: Multiple variables declared in a single declaration
3436    // currently lack the information needed to correctly determine their
3437    // ranges when accounting for the type-specifier.  We use context
3438    // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3439    // and if so, whether it is the first decl.
3440    if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3441      if (!cxcursor::isFirstInDeclGroup(C))
3442        R.setBegin(VD->getLocation());
3443    }
3444    return R;
3445  }
3446  return SourceRange();
3447}
3448
3449/// \brief Retrieves the "raw" cursor extent, which is then extended to include
3450/// the decl-specifier-seq for declarations.
3451static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr) {
3452  if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl) {
3453    Decl *D = cxcursor::getCursorDecl(C);
3454    SourceRange R = D->getSourceRange();
3455
3456    if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
3457      if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
3458        TypeLoc TL = TI->getTypeLoc();
3459        SourceLocation TLoc = TL.getSourceRange().getBegin();
3460        if (TLoc.isValid() && R.getBegin().isValid() &&
3461            SrcMgr.isBeforeInTranslationUnit(TLoc, R.getBegin()))
3462          R.setBegin(TLoc);
3463      }
3464
3465      // FIXME: Multiple variables declared in a single declaration
3466      // currently lack the information needed to correctly determine their
3467      // ranges when accounting for the type-specifier.  We use context
3468      // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3469      // and if so, whether it is the first decl.
3470      if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3471        if (!cxcursor::isFirstInDeclGroup(C))
3472          R.setBegin(VD->getLocation());
3473      }
3474    }
3475
3476    return R;
3477  }
3478
3479  return getRawCursorExtent(C);
3480}
3481
3482extern "C" {
3483
3484CXSourceRange clang_getCursorExtent(CXCursor C) {
3485  SourceRange R = getRawCursorExtent(C);
3486  if (R.isInvalid())
3487    return clang_getNullRange();
3488
3489  return cxloc::translateSourceRange(getCursorContext(C), R);
3490}
3491
3492CXCursor clang_getCursorReferenced(CXCursor C) {
3493  if (clang_isInvalid(C.kind))
3494    return clang_getNullCursor();
3495
3496  CXTranslationUnit tu = getCursorTU(C);
3497  if (clang_isDeclaration(C.kind)) {
3498    Decl *D = getCursorDecl(C);
3499    if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
3500      return MakeCursorOverloadedDeclRef(Using, D->getLocation(), tu);
3501    if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
3502      return MakeCursorOverloadedDeclRef(Classes, D->getLocation(), tu);
3503    if (ObjCForwardProtocolDecl *Protocols
3504                                        = dyn_cast<ObjCForwardProtocolDecl>(D))
3505      return MakeCursorOverloadedDeclRef(Protocols, D->getLocation(), tu);
3506    if (ObjCPropertyImplDecl *PropImpl =llvm::dyn_cast<ObjCPropertyImplDecl>(D))
3507      if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
3508        return MakeCXCursor(Property, tu);
3509
3510    return C;
3511  }
3512
3513  if (clang_isExpression(C.kind)) {
3514    Expr *E = getCursorExpr(C);
3515    Decl *D = getDeclFromExpr(E);
3516    if (D)
3517      return MakeCXCursor(D, tu);
3518
3519    if (OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E))
3520      return MakeCursorOverloadedDeclRef(Ovl, tu);
3521
3522    return clang_getNullCursor();
3523  }
3524
3525  if (clang_isStatement(C.kind)) {
3526    Stmt *S = getCursorStmt(C);
3527    if (GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S))
3528      return MakeCXCursor(Goto->getLabel(), getCursorDecl(C), tu);
3529
3530    return clang_getNullCursor();
3531  }
3532
3533  if (C.kind == CXCursor_MacroInstantiation) {
3534    if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition())
3535      return MakeMacroDefinitionCursor(Def, tu);
3536  }
3537
3538  if (!clang_isReference(C.kind))
3539    return clang_getNullCursor();
3540
3541  switch (C.kind) {
3542    case CXCursor_ObjCSuperClassRef:
3543      return MakeCXCursor(getCursorObjCSuperClassRef(C).first, tu);
3544
3545    case CXCursor_ObjCProtocolRef: {
3546      return MakeCXCursor(getCursorObjCProtocolRef(C).first, tu);
3547
3548    case CXCursor_ObjCClassRef:
3549      return MakeCXCursor(getCursorObjCClassRef(C).first, tu );
3550
3551    case CXCursor_TypeRef:
3552      return MakeCXCursor(getCursorTypeRef(C).first, tu );
3553
3554    case CXCursor_TemplateRef:
3555      return MakeCXCursor(getCursorTemplateRef(C).first, tu );
3556
3557    case CXCursor_NamespaceRef:
3558      return MakeCXCursor(getCursorNamespaceRef(C).first, tu );
3559
3560    case CXCursor_MemberRef:
3561      return MakeCXCursor(getCursorMemberRef(C).first, tu );
3562
3563    case CXCursor_CXXBaseSpecifier: {
3564      CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
3565      return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
3566                                                         tu ));
3567    }
3568
3569    case CXCursor_LabelRef:
3570      // FIXME: We end up faking the "parent" declaration here because we
3571      // don't want to make CXCursor larger.
3572      return MakeCXCursor(getCursorLabelRef(C).first,
3573               static_cast<ASTUnit*>(tu->TUData)->getASTContext()
3574                          .getTranslationUnitDecl(),
3575                          tu);
3576
3577    case CXCursor_OverloadedDeclRef:
3578      return C;
3579
3580    default:
3581      // We would prefer to enumerate all non-reference cursor kinds here.
3582      llvm_unreachable("Unhandled reference cursor kind");
3583      break;
3584    }
3585  }
3586
3587  return clang_getNullCursor();
3588}
3589
3590CXCursor clang_getCursorDefinition(CXCursor C) {
3591  if (clang_isInvalid(C.kind))
3592    return clang_getNullCursor();
3593
3594  CXTranslationUnit TU = getCursorTU(C);
3595
3596  bool WasReference = false;
3597  if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
3598    C = clang_getCursorReferenced(C);
3599    WasReference = true;
3600  }
3601
3602  if (C.kind == CXCursor_MacroInstantiation)
3603    return clang_getCursorReferenced(C);
3604
3605  if (!clang_isDeclaration(C.kind))
3606    return clang_getNullCursor();
3607
3608  Decl *D = getCursorDecl(C);
3609  if (!D)
3610    return clang_getNullCursor();
3611
3612  switch (D->getKind()) {
3613  // Declaration kinds that don't really separate the notions of
3614  // declaration and definition.
3615  case Decl::Namespace:
3616  case Decl::Typedef:
3617  case Decl::TemplateTypeParm:
3618  case Decl::EnumConstant:
3619  case Decl::Field:
3620  case Decl::IndirectField:
3621  case Decl::ObjCIvar:
3622  case Decl::ObjCAtDefsField:
3623  case Decl::ImplicitParam:
3624  case Decl::ParmVar:
3625  case Decl::NonTypeTemplateParm:
3626  case Decl::TemplateTemplateParm:
3627  case Decl::ObjCCategoryImpl:
3628  case Decl::ObjCImplementation:
3629  case Decl::AccessSpec:
3630  case Decl::LinkageSpec:
3631  case Decl::ObjCPropertyImpl:
3632  case Decl::FileScopeAsm:
3633  case Decl::StaticAssert:
3634  case Decl::Block:
3635    return C;
3636
3637  // Declaration kinds that don't make any sense here, but are
3638  // nonetheless harmless.
3639  case Decl::TranslationUnit:
3640    break;
3641
3642  // Declaration kinds for which the definition is not resolvable.
3643  case Decl::UnresolvedUsingTypename:
3644  case Decl::UnresolvedUsingValue:
3645    break;
3646
3647  case Decl::UsingDirective:
3648    return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
3649                        TU);
3650
3651  case Decl::NamespaceAlias:
3652    return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), TU);
3653
3654  case Decl::Enum:
3655  case Decl::Record:
3656  case Decl::CXXRecord:
3657  case Decl::ClassTemplateSpecialization:
3658  case Decl::ClassTemplatePartialSpecialization:
3659    if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
3660      return MakeCXCursor(Def, TU);
3661    return clang_getNullCursor();
3662
3663  case Decl::Function:
3664  case Decl::CXXMethod:
3665  case Decl::CXXConstructor:
3666  case Decl::CXXDestructor:
3667  case Decl::CXXConversion: {
3668    const FunctionDecl *Def = 0;
3669    if (cast<FunctionDecl>(D)->getBody(Def))
3670      return MakeCXCursor(const_cast<FunctionDecl *>(Def), TU);
3671    return clang_getNullCursor();
3672  }
3673
3674  case Decl::Var: {
3675    // Ask the variable if it has a definition.
3676    if (VarDecl *Def = cast<VarDecl>(D)->getDefinition())
3677      return MakeCXCursor(Def, TU);
3678    return clang_getNullCursor();
3679  }
3680
3681  case Decl::FunctionTemplate: {
3682    const FunctionDecl *Def = 0;
3683    if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
3684      return MakeCXCursor(Def->getDescribedFunctionTemplate(), TU);
3685    return clang_getNullCursor();
3686  }
3687
3688  case Decl::ClassTemplate: {
3689    if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
3690                                                            ->getDefinition())
3691      return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
3692                          TU);
3693    return clang_getNullCursor();
3694  }
3695
3696  case Decl::Using:
3697    return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D),
3698                                       D->getLocation(), TU);
3699
3700  case Decl::UsingShadow:
3701    return clang_getCursorDefinition(
3702                       MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
3703                                    TU));
3704
3705  case Decl::ObjCMethod: {
3706    ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
3707    if (Method->isThisDeclarationADefinition())
3708      return C;
3709
3710    // Dig out the method definition in the associated
3711    // @implementation, if we have it.
3712    // FIXME: The ASTs should make finding the definition easier.
3713    if (ObjCInterfaceDecl *Class
3714                       = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
3715      if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
3716        if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
3717                                                  Method->isInstanceMethod()))
3718          if (Def->isThisDeclarationADefinition())
3719            return MakeCXCursor(Def, TU);
3720
3721    return clang_getNullCursor();
3722  }
3723
3724  case Decl::ObjCCategory:
3725    if (ObjCCategoryImplDecl *Impl
3726                               = cast<ObjCCategoryDecl>(D)->getImplementation())
3727      return MakeCXCursor(Impl, TU);
3728    return clang_getNullCursor();
3729
3730  case Decl::ObjCProtocol:
3731    if (!cast<ObjCProtocolDecl>(D)->isForwardDecl())
3732      return C;
3733    return clang_getNullCursor();
3734
3735  case Decl::ObjCInterface:
3736    // There are two notions of a "definition" for an Objective-C
3737    // class: the interface and its implementation. When we resolved a
3738    // reference to an Objective-C class, produce the @interface as
3739    // the definition; when we were provided with the interface,
3740    // produce the @implementation as the definition.
3741    if (WasReference) {
3742      if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl())
3743        return C;
3744    } else if (ObjCImplementationDecl *Impl
3745                              = cast<ObjCInterfaceDecl>(D)->getImplementation())
3746      return MakeCXCursor(Impl, TU);
3747    return clang_getNullCursor();
3748
3749  case Decl::ObjCProperty:
3750    // FIXME: We don't really know where to find the
3751    // ObjCPropertyImplDecls that implement this property.
3752    return clang_getNullCursor();
3753
3754  case Decl::ObjCCompatibleAlias:
3755    if (ObjCInterfaceDecl *Class
3756          = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
3757      if (!Class->isForwardDecl())
3758        return MakeCXCursor(Class, TU);
3759
3760    return clang_getNullCursor();
3761
3762  case Decl::ObjCForwardProtocol:
3763    return MakeCursorOverloadedDeclRef(cast<ObjCForwardProtocolDecl>(D),
3764                                       D->getLocation(), TU);
3765
3766  case Decl::ObjCClass:
3767    return MakeCursorOverloadedDeclRef(cast<ObjCClassDecl>(D), D->getLocation(),
3768                                       TU);
3769
3770  case Decl::Friend:
3771    if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
3772      return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
3773    return clang_getNullCursor();
3774
3775  case Decl::FriendTemplate:
3776    if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
3777      return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
3778    return clang_getNullCursor();
3779  }
3780
3781  return clang_getNullCursor();
3782}
3783
3784unsigned clang_isCursorDefinition(CXCursor C) {
3785  if (!clang_isDeclaration(C.kind))
3786    return 0;
3787
3788  return clang_getCursorDefinition(C) == C;
3789}
3790
3791CXCursor clang_getCanonicalCursor(CXCursor C) {
3792  if (!clang_isDeclaration(C.kind))
3793    return C;
3794
3795  if (Decl *D = getCursorDecl(C))
3796    return MakeCXCursor(D->getCanonicalDecl(), getCursorTU(C));
3797
3798  return C;
3799}
3800
3801unsigned clang_getNumOverloadedDecls(CXCursor C) {
3802  if (C.kind != CXCursor_OverloadedDeclRef)
3803    return 0;
3804
3805  OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
3806  if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
3807    return E->getNumDecls();
3808
3809  if (OverloadedTemplateStorage *S
3810                              = Storage.dyn_cast<OverloadedTemplateStorage*>())
3811    return S->size();
3812
3813  Decl *D = Storage.get<Decl*>();
3814  if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
3815    return Using->shadow_size();
3816  if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
3817    return Classes->size();
3818  if (ObjCForwardProtocolDecl *Protocols =dyn_cast<ObjCForwardProtocolDecl>(D))
3819    return Protocols->protocol_size();
3820
3821  return 0;
3822}
3823
3824CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) {
3825  if (cursor.kind != CXCursor_OverloadedDeclRef)
3826    return clang_getNullCursor();
3827
3828  if (index >= clang_getNumOverloadedDecls(cursor))
3829    return clang_getNullCursor();
3830
3831  CXTranslationUnit TU = getCursorTU(cursor);
3832  OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first;
3833  if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
3834    return MakeCXCursor(E->decls_begin()[index], TU);
3835
3836  if (OverloadedTemplateStorage *S
3837                              = Storage.dyn_cast<OverloadedTemplateStorage*>())
3838    return MakeCXCursor(S->begin()[index], TU);
3839
3840  Decl *D = Storage.get<Decl*>();
3841  if (UsingDecl *Using = dyn_cast<UsingDecl>(D)) {
3842    // FIXME: This is, unfortunately, linear time.
3843    UsingDecl::shadow_iterator Pos = Using->shadow_begin();
3844    std::advance(Pos, index);
3845    return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), TU);
3846  }
3847
3848  if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
3849    return MakeCXCursor(Classes->begin()[index].getInterface(), TU);
3850
3851  if (ObjCForwardProtocolDecl *Protocols = dyn_cast<ObjCForwardProtocolDecl>(D))
3852    return MakeCXCursor(Protocols->protocol_begin()[index], TU);
3853
3854  return clang_getNullCursor();
3855}
3856
3857void clang_getDefinitionSpellingAndExtent(CXCursor C,
3858                                          const char **startBuf,
3859                                          const char **endBuf,
3860                                          unsigned *startLine,
3861                                          unsigned *startColumn,
3862                                          unsigned *endLine,
3863                                          unsigned *endColumn) {
3864  assert(getCursorDecl(C) && "CXCursor has null decl");
3865  NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C));
3866  FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
3867  CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
3868
3869  SourceManager &SM = FD->getASTContext().getSourceManager();
3870  *startBuf = SM.getCharacterData(Body->getLBracLoc());
3871  *endBuf = SM.getCharacterData(Body->getRBracLoc());
3872  *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
3873  *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
3874  *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
3875  *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
3876}
3877
3878void clang_enableStackTraces(void) {
3879  llvm::sys::PrintStackTraceOnErrorSignal();
3880}
3881
3882void clang_executeOnThread(void (*fn)(void*), void *user_data,
3883                           unsigned stack_size) {
3884  llvm::llvm_execute_on_thread(fn, user_data, stack_size);
3885}
3886
3887} // end: extern "C"
3888
3889//===----------------------------------------------------------------------===//
3890// Token-based Operations.
3891//===----------------------------------------------------------------------===//
3892
3893/* CXToken layout:
3894 *   int_data[0]: a CXTokenKind
3895 *   int_data[1]: starting token location
3896 *   int_data[2]: token length
3897 *   int_data[3]: reserved
3898 *   ptr_data: for identifiers and keywords, an IdentifierInfo*.
3899 *   otherwise unused.
3900 */
3901extern "C" {
3902
3903CXTokenKind clang_getTokenKind(CXToken CXTok) {
3904  return static_cast<CXTokenKind>(CXTok.int_data[0]);
3905}
3906
3907CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
3908  switch (clang_getTokenKind(CXTok)) {
3909  case CXToken_Identifier:
3910  case CXToken_Keyword:
3911    // We know we have an IdentifierInfo*, so use that.
3912    return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data)
3913                            ->getNameStart());
3914
3915  case CXToken_Literal: {
3916    // We have stashed the starting pointer in the ptr_data field. Use it.
3917    const char *Text = static_cast<const char *>(CXTok.ptr_data);
3918    return createCXString(llvm::StringRef(Text, CXTok.int_data[2]));
3919  }
3920
3921  case CXToken_Punctuation:
3922  case CXToken_Comment:
3923    break;
3924  }
3925
3926  // We have to find the starting buffer pointer the hard way, by
3927  // deconstructing the source location.
3928  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
3929  if (!CXXUnit)
3930    return createCXString("");
3931
3932  SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
3933  std::pair<FileID, unsigned> LocInfo
3934    = CXXUnit->getSourceManager().getDecomposedLoc(Loc);
3935  bool Invalid = false;
3936  llvm::StringRef Buffer
3937    = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
3938  if (Invalid)
3939    return createCXString("");
3940
3941  return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
3942}
3943
3944CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
3945  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
3946  if (!CXXUnit)
3947    return clang_getNullLocation();
3948
3949  return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
3950                        SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3951}
3952
3953CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
3954  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
3955  if (!CXXUnit)
3956    return clang_getNullRange();
3957
3958  return cxloc::translateSourceRange(CXXUnit->getASTContext(),
3959                        SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3960}
3961
3962void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
3963                    CXToken **Tokens, unsigned *NumTokens) {
3964  if (Tokens)
3965    *Tokens = 0;
3966  if (NumTokens)
3967    *NumTokens = 0;
3968
3969  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
3970  if (!CXXUnit || !Tokens || !NumTokens)
3971    return;
3972
3973  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3974
3975  SourceRange R = cxloc::translateCXSourceRange(Range);
3976  if (R.isInvalid())
3977    return;
3978
3979  SourceManager &SourceMgr = CXXUnit->getSourceManager();
3980  std::pair<FileID, unsigned> BeginLocInfo
3981    = SourceMgr.getDecomposedLoc(R.getBegin());
3982  std::pair<FileID, unsigned> EndLocInfo
3983    = SourceMgr.getDecomposedLoc(R.getEnd());
3984
3985  // Cannot tokenize across files.
3986  if (BeginLocInfo.first != EndLocInfo.first)
3987    return;
3988
3989  // Create a lexer
3990  bool Invalid = false;
3991  llvm::StringRef Buffer
3992    = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
3993  if (Invalid)
3994    return;
3995
3996  Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
3997            CXXUnit->getASTContext().getLangOptions(),
3998            Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
3999  Lex.SetCommentRetentionState(true);
4000
4001  // Lex tokens until we hit the end of the range.
4002  const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
4003  llvm::SmallVector<CXToken, 32> CXTokens;
4004  Token Tok;
4005  bool previousWasAt = false;
4006  do {
4007    // Lex the next token
4008    Lex.LexFromRawLexer(Tok);
4009    if (Tok.is(tok::eof))
4010      break;
4011
4012    // Initialize the CXToken.
4013    CXToken CXTok;
4014
4015    //   - Common fields
4016    CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
4017    CXTok.int_data[2] = Tok.getLength();
4018    CXTok.int_data[3] = 0;
4019
4020    //   - Kind-specific fields
4021    if (Tok.isLiteral()) {
4022      CXTok.int_data[0] = CXToken_Literal;
4023      CXTok.ptr_data = (void *)Tok.getLiteralData();
4024    } else if (Tok.is(tok::raw_identifier)) {
4025      // Lookup the identifier to determine whether we have a keyword.
4026      IdentifierInfo *II
4027        = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok);
4028
4029      if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) {
4030        CXTok.int_data[0] = CXToken_Keyword;
4031      }
4032      else {
4033        CXTok.int_data[0] = Tok.is(tok::identifier)
4034          ? CXToken_Identifier
4035          : CXToken_Keyword;
4036      }
4037      CXTok.ptr_data = II;
4038    } else if (Tok.is(tok::comment)) {
4039      CXTok.int_data[0] = CXToken_Comment;
4040      CXTok.ptr_data = 0;
4041    } else {
4042      CXTok.int_data[0] = CXToken_Punctuation;
4043      CXTok.ptr_data = 0;
4044    }
4045    CXTokens.push_back(CXTok);
4046    previousWasAt = Tok.is(tok::at);
4047  } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
4048
4049  if (CXTokens.empty())
4050    return;
4051
4052  *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
4053  memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
4054  *NumTokens = CXTokens.size();
4055}
4056
4057void clang_disposeTokens(CXTranslationUnit TU,
4058                         CXToken *Tokens, unsigned NumTokens) {
4059  free(Tokens);
4060}
4061
4062} // end: extern "C"
4063
4064//===----------------------------------------------------------------------===//
4065// Token annotation APIs.
4066//===----------------------------------------------------------------------===//
4067
4068typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData;
4069static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
4070                                                     CXCursor parent,
4071                                                     CXClientData client_data);
4072namespace {
4073class AnnotateTokensWorker {
4074  AnnotateTokensData &Annotated;
4075  CXToken *Tokens;
4076  CXCursor *Cursors;
4077  unsigned NumTokens;
4078  unsigned TokIdx;
4079  unsigned PreprocessingTokIdx;
4080  CursorVisitor AnnotateVis;
4081  SourceManager &SrcMgr;
4082
4083  bool MoreTokens() const { return TokIdx < NumTokens; }
4084  unsigned NextToken() const { return TokIdx; }
4085  void AdvanceToken() { ++TokIdx; }
4086  SourceLocation GetTokenLoc(unsigned tokI) {
4087    return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]);
4088  }
4089
4090public:
4091  AnnotateTokensWorker(AnnotateTokensData &annotated,
4092                       CXToken *tokens, CXCursor *cursors, unsigned numTokens,
4093                       CXTranslationUnit tu, SourceRange RegionOfInterest)
4094    : Annotated(annotated), Tokens(tokens), Cursors(cursors),
4095      NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0),
4096      AnnotateVis(tu,
4097                  AnnotateTokensVisitor, this,
4098                  Decl::MaxPCHLevel, RegionOfInterest),
4099      SrcMgr(static_cast<ASTUnit*>(tu->TUData)->getSourceManager()) {}
4100
4101  void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
4102  enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
4103  void AnnotateTokens(CXCursor parent);
4104  void AnnotateTokens() {
4105    AnnotateTokens(clang_getTranslationUnitCursor(AnnotateVis.getTU()));
4106  }
4107};
4108}
4109
4110void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) {
4111  // Walk the AST within the region of interest, annotating tokens
4112  // along the way.
4113  VisitChildren(parent);
4114
4115  for (unsigned I = 0 ; I < TokIdx ; ++I) {
4116    AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
4117    if (Pos != Annotated.end() &&
4118        (clang_isInvalid(Cursors[I].kind) ||
4119         Pos->second.kind != CXCursor_PreprocessingDirective))
4120      Cursors[I] = Pos->second;
4121  }
4122
4123  // Finish up annotating any tokens left.
4124  if (!MoreTokens())
4125    return;
4126
4127  const CXCursor &C = clang_getNullCursor();
4128  for (unsigned I = TokIdx ; I < NumTokens ; ++I) {
4129    AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
4130    Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second;
4131  }
4132}
4133
4134enum CXChildVisitResult
4135AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
4136  CXSourceLocation Loc = clang_getCursorLocation(cursor);
4137  SourceRange cursorRange = getRawCursorExtent(cursor);
4138  if (cursorRange.isInvalid())
4139    return CXChildVisit_Recurse;
4140
4141  if (clang_isPreprocessing(cursor.kind)) {
4142    // For macro instantiations, just note where the beginning of the macro
4143    // instantiation occurs.
4144    if (cursor.kind == CXCursor_MacroInstantiation) {
4145      Annotated[Loc.int_data] = cursor;
4146      return CXChildVisit_Recurse;
4147    }
4148
4149    // Items in the preprocessing record are kept separate from items in
4150    // declarations, so we keep a separate token index.
4151    unsigned SavedTokIdx = TokIdx;
4152    TokIdx = PreprocessingTokIdx;
4153
4154    // Skip tokens up until we catch up to the beginning of the preprocessing
4155    // entry.
4156    while (MoreTokens()) {
4157      const unsigned I = NextToken();
4158      SourceLocation TokLoc = GetTokenLoc(I);
4159      switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4160      case RangeBefore:
4161        AdvanceToken();
4162        continue;
4163      case RangeAfter:
4164      case RangeOverlap:
4165        break;
4166      }
4167      break;
4168    }
4169
4170    // Look at all of the tokens within this range.
4171    while (MoreTokens()) {
4172      const unsigned I = NextToken();
4173      SourceLocation TokLoc = GetTokenLoc(I);
4174      switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4175      case RangeBefore:
4176        assert(0 && "Infeasible");
4177      case RangeAfter:
4178        break;
4179      case RangeOverlap:
4180        Cursors[I] = cursor;
4181        AdvanceToken();
4182        continue;
4183      }
4184      break;
4185    }
4186
4187    // Save the preprocessing token index; restore the non-preprocessing
4188    // token index.
4189    PreprocessingTokIdx = TokIdx;
4190    TokIdx = SavedTokIdx;
4191    return CXChildVisit_Recurse;
4192  }
4193
4194  if (cursorRange.isInvalid())
4195    return CXChildVisit_Continue;
4196
4197  SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data);
4198
4199  // Adjust the annotated range based specific declarations.
4200  const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
4201  if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) {
4202    Decl *D = cxcursor::getCursorDecl(cursor);
4203    // Don't visit synthesized ObjC methods, since they have no syntatic
4204    // representation in the source.
4205    if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
4206      if (MD->isSynthesized())
4207        return CXChildVisit_Continue;
4208    }
4209    if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
4210      if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
4211        TypeLoc TL = TI->getTypeLoc();
4212        SourceLocation TLoc = TL.getSourceRange().getBegin();
4213        if (TLoc.isValid() && L.isValid() &&
4214            SrcMgr.isBeforeInTranslationUnit(TLoc, L))
4215          cursorRange.setBegin(TLoc);
4216      }
4217    }
4218  }
4219
4220  // If the location of the cursor occurs within a macro instantiation, record
4221  // the spelling location of the cursor in our annotation map.  We can then
4222  // paper over the token labelings during a post-processing step to try and
4223  // get cursor mappings for tokens that are the *arguments* of a macro
4224  // instantiation.
4225  if (L.isMacroID()) {
4226    unsigned rawEncoding = SrcMgr.getSpellingLoc(L).getRawEncoding();
4227    // Only invalidate the old annotation if it isn't part of a preprocessing
4228    // directive.  Here we assume that the default construction of CXCursor
4229    // results in CXCursor.kind being an initialized value (i.e., 0).  If
4230    // this isn't the case, we can fix by doing lookup + insertion.
4231
4232    CXCursor &oldC = Annotated[rawEncoding];
4233    if (!clang_isPreprocessing(oldC.kind))
4234      oldC = cursor;
4235  }
4236
4237  const enum CXCursorKind K = clang_getCursorKind(parent);
4238  const CXCursor updateC =
4239    (clang_isInvalid(K) || K == CXCursor_TranslationUnit)
4240     ? clang_getNullCursor() : parent;
4241
4242  while (MoreTokens()) {
4243    const unsigned I = NextToken();
4244    SourceLocation TokLoc = GetTokenLoc(I);
4245    switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4246      case RangeBefore:
4247        Cursors[I] = updateC;
4248        AdvanceToken();
4249        continue;
4250      case RangeAfter:
4251      case RangeOverlap:
4252        break;
4253    }
4254    break;
4255  }
4256
4257  // Visit children to get their cursor information.
4258  const unsigned BeforeChildren = NextToken();
4259  VisitChildren(cursor);
4260  const unsigned AfterChildren = NextToken();
4261
4262  // Adjust 'Last' to the last token within the extent of the cursor.
4263  while (MoreTokens()) {
4264    const unsigned I = NextToken();
4265    SourceLocation TokLoc = GetTokenLoc(I);
4266    switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4267      case RangeBefore:
4268        assert(0 && "Infeasible");
4269      case RangeAfter:
4270        break;
4271      case RangeOverlap:
4272        Cursors[I] = updateC;
4273        AdvanceToken();
4274        continue;
4275    }
4276    break;
4277  }
4278  const unsigned Last = NextToken();
4279
4280  // Scan the tokens that are at the beginning of the cursor, but are not
4281  // capture by the child cursors.
4282
4283  // For AST elements within macros, rely on a post-annotate pass to
4284  // to correctly annotate the tokens with cursors.  Otherwise we can
4285  // get confusing results of having tokens that map to cursors that really
4286  // are expanded by an instantiation.
4287  if (L.isMacroID())
4288    cursor = clang_getNullCursor();
4289
4290  for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
4291    if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
4292      break;
4293
4294    Cursors[I] = cursor;
4295  }
4296  // Scan the tokens that are at the end of the cursor, but are not captured
4297  // but the child cursors.
4298  for (unsigned I = AfterChildren; I != Last; ++I)
4299    Cursors[I] = cursor;
4300
4301  TokIdx = Last;
4302  return CXChildVisit_Continue;
4303}
4304
4305static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
4306                                                     CXCursor parent,
4307                                                     CXClientData client_data) {
4308  return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
4309}
4310
4311// This gets run a separate thread to avoid stack blowout.
4312static void runAnnotateTokensWorker(void *UserData) {
4313  ((AnnotateTokensWorker*)UserData)->AnnotateTokens();
4314}
4315
4316extern "C" {
4317
4318void clang_annotateTokens(CXTranslationUnit TU,
4319                          CXToken *Tokens, unsigned NumTokens,
4320                          CXCursor *Cursors) {
4321
4322  if (NumTokens == 0 || !Tokens || !Cursors)
4323    return;
4324
4325  // Any token we don't specifically annotate will have a NULL cursor.
4326  CXCursor C = clang_getNullCursor();
4327  for (unsigned I = 0; I != NumTokens; ++I)
4328    Cursors[I] = C;
4329
4330  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
4331  if (!CXXUnit)
4332    return;
4333
4334  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
4335
4336  // Determine the region of interest, which contains all of the tokens.
4337  SourceRange RegionOfInterest;
4338  RegionOfInterest.setBegin(cxloc::translateSourceLocation(
4339                                        clang_getTokenLocation(TU, Tokens[0])));
4340  RegionOfInterest.setEnd(cxloc::translateSourceLocation(
4341                                clang_getTokenLocation(TU,
4342                                                       Tokens[NumTokens - 1])));
4343
4344  // A mapping from the source locations found when re-lexing or traversing the
4345  // region of interest to the corresponding cursors.
4346  AnnotateTokensData Annotated;
4347
4348  // Relex the tokens within the source range to look for preprocessing
4349  // directives.
4350  SourceManager &SourceMgr = CXXUnit->getSourceManager();
4351  std::pair<FileID, unsigned> BeginLocInfo
4352    = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin());
4353  std::pair<FileID, unsigned> EndLocInfo
4354    = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd());
4355
4356  llvm::StringRef Buffer;
4357  bool Invalid = false;
4358  if (BeginLocInfo.first == EndLocInfo.first &&
4359      ((Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid)),true) &&
4360      !Invalid) {
4361    Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
4362              CXXUnit->getASTContext().getLangOptions(),
4363              Buffer.begin(), Buffer.data() + BeginLocInfo.second,
4364              Buffer.end());
4365    Lex.SetCommentRetentionState(true);
4366
4367    // Lex tokens in raw mode until we hit the end of the range, to avoid
4368    // entering #includes or expanding macros.
4369    while (true) {
4370      Token Tok;
4371      Lex.LexFromRawLexer(Tok);
4372
4373    reprocess:
4374      if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
4375        // We have found a preprocessing directive. Gobble it up so that we
4376        // don't see it while preprocessing these tokens later, but keep track
4377        // of all of the token locations inside this preprocessing directive so
4378        // that we can annotate them appropriately.
4379        //
4380        // FIXME: Some simple tests here could identify macro definitions and
4381        // #undefs, to provide specific cursor kinds for those.
4382        std::vector<SourceLocation> Locations;
4383        do {
4384          Locations.push_back(Tok.getLocation());
4385          Lex.LexFromRawLexer(Tok);
4386        } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof));
4387
4388        using namespace cxcursor;
4389        CXCursor Cursor
4390          = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(),
4391                                                         Locations.back()),
4392                                           TU);
4393        for (unsigned I = 0, N = Locations.size(); I != N; ++I) {
4394          Annotated[Locations[I].getRawEncoding()] = Cursor;
4395        }
4396
4397        if (Tok.isAtStartOfLine())
4398          goto reprocess;
4399
4400        continue;
4401      }
4402
4403      if (Tok.is(tok::eof))
4404        break;
4405    }
4406  }
4407
4408  // Annotate all of the source locations in the region of interest that map to
4409  // a specific cursor.
4410  AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens,
4411                         TU, RegionOfInterest);
4412
4413  // Run the worker within a CrashRecoveryContext.
4414  // FIXME: We use a ridiculous stack size here because the data-recursion
4415  // algorithm uses a large stack frame than the non-data recursive version,
4416  // and AnnotationTokensWorker currently transforms the data-recursion
4417  // algorithm back into a traditional recursion by explicitly calling
4418  // VisitChildren().  We will need to remove this explicit recursive call.
4419  llvm::CrashRecoveryContext CRC;
4420  if (!RunSafely(CRC, runAnnotateTokensWorker, &W,
4421                 GetSafetyThreadStackSize() * 2)) {
4422    fprintf(stderr, "libclang: crash detected while annotating tokens\n");
4423  }
4424}
4425} // end: extern "C"
4426
4427//===----------------------------------------------------------------------===//
4428// Operations for querying linkage of a cursor.
4429//===----------------------------------------------------------------------===//
4430
4431extern "C" {
4432CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
4433  if (!clang_isDeclaration(cursor.kind))
4434    return CXLinkage_Invalid;
4435
4436  Decl *D = cxcursor::getCursorDecl(cursor);
4437  if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
4438    switch (ND->getLinkage()) {
4439      case NoLinkage: return CXLinkage_NoLinkage;
4440      case InternalLinkage: return CXLinkage_Internal;
4441      case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
4442      case ExternalLinkage: return CXLinkage_External;
4443    };
4444
4445  return CXLinkage_Invalid;
4446}
4447} // end: extern "C"
4448
4449//===----------------------------------------------------------------------===//
4450// Operations for querying language of a cursor.
4451//===----------------------------------------------------------------------===//
4452
4453static CXLanguageKind getDeclLanguage(const Decl *D) {
4454  switch (D->getKind()) {
4455    default:
4456      break;
4457    case Decl::ImplicitParam:
4458    case Decl::ObjCAtDefsField:
4459    case Decl::ObjCCategory:
4460    case Decl::ObjCCategoryImpl:
4461    case Decl::ObjCClass:
4462    case Decl::ObjCCompatibleAlias:
4463    case Decl::ObjCForwardProtocol:
4464    case Decl::ObjCImplementation:
4465    case Decl::ObjCInterface:
4466    case Decl::ObjCIvar:
4467    case Decl::ObjCMethod:
4468    case Decl::ObjCProperty:
4469    case Decl::ObjCPropertyImpl:
4470    case Decl::ObjCProtocol:
4471      return CXLanguage_ObjC;
4472    case Decl::CXXConstructor:
4473    case Decl::CXXConversion:
4474    case Decl::CXXDestructor:
4475    case Decl::CXXMethod:
4476    case Decl::CXXRecord:
4477    case Decl::ClassTemplate:
4478    case Decl::ClassTemplatePartialSpecialization:
4479    case Decl::ClassTemplateSpecialization:
4480    case Decl::Friend:
4481    case Decl::FriendTemplate:
4482    case Decl::FunctionTemplate:
4483    case Decl::LinkageSpec:
4484    case Decl::Namespace:
4485    case Decl::NamespaceAlias:
4486    case Decl::NonTypeTemplateParm:
4487    case Decl::StaticAssert:
4488    case Decl::TemplateTemplateParm:
4489    case Decl::TemplateTypeParm:
4490    case Decl::UnresolvedUsingTypename:
4491    case Decl::UnresolvedUsingValue:
4492    case Decl::Using:
4493    case Decl::UsingDirective:
4494    case Decl::UsingShadow:
4495      return CXLanguage_CPlusPlus;
4496  }
4497
4498  return CXLanguage_C;
4499}
4500
4501extern "C" {
4502
4503enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
4504  if (clang_isDeclaration(cursor.kind))
4505    if (Decl *D = cxcursor::getCursorDecl(cursor)) {
4506      if (D->hasAttr<UnavailableAttr>() ||
4507          (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted()))
4508        return CXAvailability_Available;
4509
4510      if (D->hasAttr<DeprecatedAttr>())
4511        return CXAvailability_Deprecated;
4512    }
4513
4514  return CXAvailability_Available;
4515}
4516
4517CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
4518  if (clang_isDeclaration(cursor.kind))
4519    return getDeclLanguage(cxcursor::getCursorDecl(cursor));
4520
4521  return CXLanguage_Invalid;
4522}
4523
4524 /// \brief If the given cursor is the "templated" declaration
4525 /// descibing a class or function template, return the class or
4526 /// function template.
4527static Decl *maybeGetTemplateCursor(Decl *D) {
4528  if (!D)
4529    return 0;
4530
4531  if (FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
4532    if (FunctionTemplateDecl *FunTmpl = FD->getDescribedFunctionTemplate())
4533      return FunTmpl;
4534
4535  if (CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D))
4536    if (ClassTemplateDecl *ClassTmpl = RD->getDescribedClassTemplate())
4537      return ClassTmpl;
4538
4539  return D;
4540}
4541
4542CXCursor clang_getCursorSemanticParent(CXCursor cursor) {
4543  if (clang_isDeclaration(cursor.kind)) {
4544    if (Decl *D = getCursorDecl(cursor)) {
4545      DeclContext *DC = D->getDeclContext();
4546      if (!DC)
4547        return clang_getNullCursor();
4548
4549      return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
4550                          getCursorTU(cursor));
4551    }
4552  }
4553
4554  if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) {
4555    if (Decl *D = getCursorDecl(cursor))
4556      return MakeCXCursor(D, getCursorTU(cursor));
4557  }
4558
4559  return clang_getNullCursor();
4560}
4561
4562CXCursor clang_getCursorLexicalParent(CXCursor cursor) {
4563  if (clang_isDeclaration(cursor.kind)) {
4564    if (Decl *D = getCursorDecl(cursor)) {
4565      DeclContext *DC = D->getLexicalDeclContext();
4566      if (!DC)
4567        return clang_getNullCursor();
4568
4569      return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
4570                          getCursorTU(cursor));
4571    }
4572  }
4573
4574  // FIXME: Note that we can't easily compute the lexical context of a
4575  // statement or expression, so we return nothing.
4576  return clang_getNullCursor();
4577}
4578
4579static void CollectOverriddenMethods(DeclContext *Ctx,
4580                                     ObjCMethodDecl *Method,
4581                            llvm::SmallVectorImpl<ObjCMethodDecl *> &Methods) {
4582  if (!Ctx)
4583    return;
4584
4585  // If we have a class or category implementation, jump straight to the
4586  // interface.
4587  if (ObjCImplDecl *Impl = dyn_cast<ObjCImplDecl>(Ctx))
4588    return CollectOverriddenMethods(Impl->getClassInterface(), Method, Methods);
4589
4590  ObjCContainerDecl *Container = dyn_cast<ObjCContainerDecl>(Ctx);
4591  if (!Container)
4592    return;
4593
4594  // Check whether we have a matching method at this level.
4595  if (ObjCMethodDecl *Overridden = Container->getMethod(Method->getSelector(),
4596                                                    Method->isInstanceMethod()))
4597    if (Method != Overridden) {
4598      // We found an override at this level; there is no need to look
4599      // into other protocols or categories.
4600      Methods.push_back(Overridden);
4601      return;
4602    }
4603
4604  if (ObjCProtocolDecl *Protocol = dyn_cast<ObjCProtocolDecl>(Container)) {
4605    for (ObjCProtocolDecl::protocol_iterator P = Protocol->protocol_begin(),
4606                                          PEnd = Protocol->protocol_end();
4607         P != PEnd; ++P)
4608      CollectOverriddenMethods(*P, Method, Methods);
4609  }
4610
4611  if (ObjCCategoryDecl *Category = dyn_cast<ObjCCategoryDecl>(Container)) {
4612    for (ObjCCategoryDecl::protocol_iterator P = Category->protocol_begin(),
4613                                          PEnd = Category->protocol_end();
4614         P != PEnd; ++P)
4615      CollectOverriddenMethods(*P, Method, Methods);
4616  }
4617
4618  if (ObjCInterfaceDecl *Interface = dyn_cast<ObjCInterfaceDecl>(Container)) {
4619    for (ObjCInterfaceDecl::protocol_iterator P = Interface->protocol_begin(),
4620                                           PEnd = Interface->protocol_end();
4621         P != PEnd; ++P)
4622      CollectOverriddenMethods(*P, Method, Methods);
4623
4624    for (ObjCCategoryDecl *Category = Interface->getCategoryList();
4625         Category; Category = Category->getNextClassCategory())
4626      CollectOverriddenMethods(Category, Method, Methods);
4627
4628    // We only look into the superclass if we haven't found anything yet.
4629    if (Methods.empty())
4630      if (ObjCInterfaceDecl *Super = Interface->getSuperClass())
4631        return CollectOverriddenMethods(Super, Method, Methods);
4632  }
4633}
4634
4635void clang_getOverriddenCursors(CXCursor cursor,
4636                                CXCursor **overridden,
4637                                unsigned *num_overridden) {
4638  if (overridden)
4639    *overridden = 0;
4640  if (num_overridden)
4641    *num_overridden = 0;
4642  if (!overridden || !num_overridden)
4643    return;
4644
4645  if (!clang_isDeclaration(cursor.kind))
4646    return;
4647
4648  Decl *D = getCursorDecl(cursor);
4649  if (!D)
4650    return;
4651
4652  // Handle C++ member functions.
4653  CXTranslationUnit TU = getCursorTU(cursor);
4654  if (CXXMethodDecl *CXXMethod = dyn_cast<CXXMethodDecl>(D)) {
4655    *num_overridden = CXXMethod->size_overridden_methods();
4656    if (!*num_overridden)
4657      return;
4658
4659    *overridden = new CXCursor [*num_overridden];
4660    unsigned I = 0;
4661    for (CXXMethodDecl::method_iterator
4662              M = CXXMethod->begin_overridden_methods(),
4663           MEnd = CXXMethod->end_overridden_methods();
4664         M != MEnd; (void)++M, ++I)
4665      (*overridden)[I] = MakeCXCursor(const_cast<CXXMethodDecl*>(*M), TU);
4666    return;
4667  }
4668
4669  ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D);
4670  if (!Method)
4671    return;
4672
4673  // Handle Objective-C methods.
4674  llvm::SmallVector<ObjCMethodDecl *, 4> Methods;
4675  CollectOverriddenMethods(Method->getDeclContext(), Method, Methods);
4676
4677  if (Methods.empty())
4678    return;
4679
4680  *num_overridden = Methods.size();
4681  *overridden = new CXCursor [Methods.size()];
4682  for (unsigned I = 0, N = Methods.size(); I != N; ++I)
4683    (*overridden)[I] = MakeCXCursor(Methods[I], TU);
4684}
4685
4686void clang_disposeOverriddenCursors(CXCursor *overridden) {
4687  delete [] overridden;
4688}
4689
4690CXFile clang_getIncludedFile(CXCursor cursor) {
4691  if (cursor.kind != CXCursor_InclusionDirective)
4692    return 0;
4693
4694  InclusionDirective *ID = getCursorInclusionDirective(cursor);
4695  return (void *)ID->getFile();
4696}
4697
4698} // end: extern "C"
4699
4700
4701//===----------------------------------------------------------------------===//
4702// C++ AST instrospection.
4703//===----------------------------------------------------------------------===//
4704
4705extern "C" {
4706unsigned clang_CXXMethod_isStatic(CXCursor C) {
4707  if (!clang_isDeclaration(C.kind))
4708    return 0;
4709
4710  CXXMethodDecl *Method = 0;
4711  Decl *D = cxcursor::getCursorDecl(C);
4712  if (FunctionTemplateDecl *FunTmpl = dyn_cast_or_null<FunctionTemplateDecl>(D))
4713    Method = dyn_cast<CXXMethodDecl>(FunTmpl->getTemplatedDecl());
4714  else
4715    Method = dyn_cast_or_null<CXXMethodDecl>(D);
4716  return (Method && Method->isStatic()) ? 1 : 0;
4717}
4718
4719} // end: extern "C"
4720
4721//===----------------------------------------------------------------------===//
4722// Attribute introspection.
4723//===----------------------------------------------------------------------===//
4724
4725extern "C" {
4726CXType clang_getIBOutletCollectionType(CXCursor C) {
4727  if (C.kind != CXCursor_IBOutletCollectionAttr)
4728    return cxtype::MakeCXType(QualType(), cxcursor::getCursorTU(C));
4729
4730  IBOutletCollectionAttr *A =
4731    cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
4732
4733  return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorTU(C));
4734}
4735} // end: extern "C"
4736
4737//===----------------------------------------------------------------------===//
4738// Misc. utility functions.
4739//===----------------------------------------------------------------------===//
4740
4741/// Default to using an 8 MB stack size on "safety" threads.
4742static unsigned SafetyStackThreadSize = 8 << 20;
4743
4744namespace clang {
4745
4746bool RunSafely(llvm::CrashRecoveryContext &CRC,
4747               void (*Fn)(void*), void *UserData,
4748               unsigned Size) {
4749  if (!Size)
4750    Size = GetSafetyThreadStackSize();
4751  if (Size)
4752    return CRC.RunSafelyOnThread(Fn, UserData, Size);
4753  return CRC.RunSafely(Fn, UserData);
4754}
4755
4756unsigned GetSafetyThreadStackSize() {
4757  return SafetyStackThreadSize;
4758}
4759
4760void SetSafetyThreadStackSize(unsigned Value) {
4761  SafetyStackThreadSize = Value;
4762}
4763
4764}
4765
4766extern "C" {
4767
4768CXString clang_getClangVersion() {
4769  return createCXString(getClangFullVersion());
4770}
4771
4772} // end: extern "C"
4773