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