blob: f28115418bdc38802c79c76ea534f657b364dd9a [file] [log] [blame]
Ted Kremenekd2fa5662009-08-26 22:36:44 +00001//===- 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.
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00007//
Ted Kremenekd2fa5662009-08-26 22:36:44 +00008//===----------------------------------------------------------------------===//
9//
Ted Kremenekab188932010-01-05 19:32:54 +000010// This file implements the main API hooks in the Clang-C Source Indexing
11// library.
Ted Kremenekd2fa5662009-08-26 22:36:44 +000012//
13//===----------------------------------------------------------------------===//
14
Ted Kremenekab188932010-01-05 19:32:54 +000015#include "CIndexer.h"
Ted Kremenek16c440a2010-01-15 20:35:54 +000016#include "CXCursor.h"
Ted Kremenek0a90d322010-11-17 23:24:11 +000017#include "CXTranslationUnit.h"
Ted Kremeneked122732010-11-16 01:56:27 +000018#include "CXString.h"
Ted Kremenek95f33552010-08-26 01:42:22 +000019#include "CXType.h"
Ted Kremeneka297de22010-01-25 22:34:44 +000020#include "CXSourceLocation.h"
Douglas Gregor5352ac02010-01-28 00:27:43 +000021#include "CIndexDiagnostic.h"
Ted Kremenekab188932010-01-05 19:32:54 +000022
Ted Kremenek04bb7162010-01-22 22:44:15 +000023#include "clang/Basic/Version.h"
Douglas Gregor936ea3b2010-01-28 00:56:43 +000024
Steve Naroff50398192009-08-28 15:28:48 +000025#include "clang/AST/DeclVisitor.h"
Steve Narofffb570422009-09-22 19:25:29 +000026#include "clang/AST/StmtVisitor.h"
Douglas Gregor7d0d40e2010-01-21 16:28:34 +000027#include "clang/AST/TypeLocVisitor.h"
Benjamin Kramerb846deb2010-04-12 19:45:50 +000028#include "clang/Basic/Diagnostic.h"
29#include "clang/Frontend/ASTUnit.h"
30#include "clang/Frontend/CompilerInstance.h"
Douglas Gregor936ea3b2010-01-28 00:56:43 +000031#include "clang/Frontend/FrontendDiagnostic.h"
Ted Kremenekd8210652010-01-06 23:43:31 +000032#include "clang/Lex/Lexer.h"
Benjamin Kramerb846deb2010-04-12 19:45:50 +000033#include "clang/Lex/PreprocessingRecord.h"
Douglas Gregor33e9abd2010-01-22 19:49:59 +000034#include "clang/Lex/Preprocessor.h"
Douglas Gregora67e03f2010-09-09 21:42:20 +000035#include "llvm/ADT/STLExtras.h"
Ted Kremenekd8c370c2010-11-02 23:10:24 +000036#include "llvm/ADT/Optional.h"
37#include "clang/Analysis/Support/SaveAndRestore.h"
Daniel Dunbarc7df4f32010-08-18 18:43:14 +000038#include "llvm/Support/CrashRecoveryContext.h"
Daniel Dunbar48615ff2010-10-08 19:30:33 +000039#include "llvm/Support/PrettyStackTrace.h"
Douglas Gregor02465752009-10-16 21:24:31 +000040#include "llvm/Support/MemoryBuffer.h"
Douglas Gregor358559d2010-10-02 22:49:11 +000041#include "llvm/Support/raw_ostream.h"
Douglas Gregor7a07fcb2010-08-09 21:00:09 +000042#include "llvm/Support/Timer.h"
Michael J. Spencer03013fa2010-11-29 18:12:39 +000043#include "llvm/Support/Mutex.h"
44#include "llvm/Support/Program.h"
45#include "llvm/Support/Signals.h"
46#include "llvm/Support/Threading.h"
Ted Kremenek37f1ea02010-11-15 23:11:54 +000047#include "llvm/Support/Compiler.h"
Ted Kremenekfc062212009-10-19 21:44:57 +000048
Steve Naroff50398192009-08-28 15:28:48 +000049using namespace clang;
Ted Kremenek16c440a2010-01-15 20:35:54 +000050using namespace clang::cxcursor;
Ted Kremenekee4db4f2010-02-17 00:41:08 +000051using namespace clang::cxstring;
Steve Naroff50398192009-08-28 15:28:48 +000052
Ted Kremeneka60ed472010-11-16 08:15:36 +000053static 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
Douglas Gregor33e9abd2010-01-22 19:49:59 +000062/// \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,
Ted Kremenekf0e23e82010-02-17 00:41:40 +000066
Douglas Gregor33e9abd2010-01-22 19:49:59 +000067 /// \brief The first range ends before the second range starts.
68 RangeBefore,
Ted Kremenekf0e23e82010-02-17 00:41:40 +000069
Douglas Gregor33e9abd2010-01-22 19:49:59 +000070 /// \brief The first range starts after the second range ends.
71 RangeAfter
72};
73
Ted Kremenekf0e23e82010-02-17 00:41:40 +000074/// \brief Compare two source ranges to determine their relative position in
Douglas Gregor33e9abd2010-01-22 19:49:59 +000075/// the translation unit.
Ted Kremenekf0e23e82010-02-17 00:41:40 +000076static RangeComparisonResult RangeCompare(SourceManager &SM,
77 SourceRange R1,
Douglas Gregor33e9abd2010-01-22 19:49:59 +000078 SourceRange R2) {
79 assert(R1.isValid() && "First range is invalid?");
80 assert(R2.isValid() && "Second range is invalid?");
Douglas Gregora8e5c5b2010-07-22 20:22:31 +000081 if (R1.getEnd() != R2.getBegin() &&
Daniel Dunbard52864b2010-02-14 10:02:57 +000082 SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
Douglas Gregor33e9abd2010-01-22 19:49:59 +000083 return RangeBefore;
Douglas Gregora8e5c5b2010-07-22 20:22:31 +000084 if (R2.getEnd() != R1.getBegin() &&
Daniel Dunbard52864b2010-02-14 10:02:57 +000085 SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin()))
Douglas Gregor33e9abd2010-01-22 19:49:59 +000086 return RangeAfter;
87 return RangeOverlap;
88}
89
Ted Kremenekfbd84ca2010-05-05 00:55:23 +000090/// \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?");
Douglas Gregora8e5c5b2010-07-22 20:22:31 +000096 if (L == R.getBegin() || L == R.getEnd())
Ted Kremenekfbd84ca2010-05-05 00:55:23 +000097 return RangeOverlap;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +000098 if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
99 return RangeBefore;
100 if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
101 return RangeAfter;
102 return RangeOverlap;
103}
104
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000105/// \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.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000111CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000112 const LangOptions &LangOpts,
Chris Lattner0a76aae2010-06-18 22:45:06 +0000113 const CharSourceRange &R) {
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000114 // We want the last character in this location, so we will adjust the
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000115 // location accordingly.
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000116 SourceLocation EndLoc = R.getEnd();
Douglas Gregora9b06d42010-11-09 06:24:54 +0000117 if (EndLoc.isValid() && EndLoc.isMacroID())
118 EndLoc = SM.getSpellingLoc(EndLoc);
Chris Lattner0a76aae2010-06-18 22:45:06 +0000119 if (R.isTokenRange() && !EndLoc.isInvalid() && EndLoc.isFileID()) {
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000120 unsigned Length = Lexer::MeasureTokenLength(EndLoc, SM, LangOpts);
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000121 EndLoc = EndLoc.getFileLocWithOffset(Length);
122 }
123
124 CXSourceRange Result = { { (void *)&SM, (void *)&LangOpts },
125 R.getBegin().getRawEncoding(),
126 EndLoc.getRawEncoding() };
127 return Result;
128}
Douglas Gregor1db19de2010-01-19 21:36:55 +0000129
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000130//===----------------------------------------------------------------------===//
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000131// Cursor visitor.
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000132//===----------------------------------------------------------------------===//
133
Steve Naroff89922f82009-08-31 00:59:03 +0000134namespace {
Ted Kremenekc0e1d922010-11-11 08:05:18 +0000135
136class VisitorJob {
137public:
Ted Kremenekcdb4caf2010-11-12 21:34:12 +0000138 enum Kind { DeclVisitKind, StmtVisitKind, MemberExprPartsKind,
Ted Kremeneke4979cc2010-11-13 00:58:18 +0000139 TypeLocVisitKind, OverloadExprPartsKind,
Ted Kremenek60608ec2010-11-17 00:50:47 +0000140 DeclRefExprPartsKind, LabelRefVisitKind,
Ted Kremenekf64d8032010-11-18 00:02:32 +0000141 ExplicitTemplateArgsVisitKind,
142 NestedNameSpecifierVisitKind,
Ted Kremenekcdba6592010-11-18 00:42:18 +0000143 DeclarationNameInfoVisitKind,
144 MemberRefVisitKind };
Ted Kremenekc0e1d922010-11-11 08:05:18 +0000145protected:
Ted Kremenekf64d8032010-11-18 00:02:32 +0000146 void *data[3];
Ted Kremenekc0e1d922010-11-11 08:05:18 +0000147 CXCursor parent;
148 Kind K;
Ted Kremenekf64d8032010-11-18 00:02:32 +0000149 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 }
Ted Kremenekc0e1d922010-11-11 08:05:18 +0000155public:
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
Douglas Gregorb1373d02010-01-20 20:59:29 +0000163// Cursor visitor.
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000164class CursorVisitor : public DeclVisitor<CursorVisitor, bool>,
Ted Kremenekcdba6592010-11-18 00:42:18 +0000165 public TypeLocVisitor<CursorVisitor, bool>
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000166{
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000167 /// \brief The translation unit we are traversing.
Ted Kremeneka60ed472010-11-16 08:15:36 +0000168 CXTranslationUnit TU;
169 ASTUnit *AU;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000170
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000171 /// \brief The parent cursor whose children we are traversing.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000172 CXCursor Parent;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000173
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000174 /// \brief The declaration that serves at the parent of any statement or
175 /// expression nodes.
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000176 Decl *StmtParent;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000177
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000178 /// \brief The visitor function.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000179 CXCursorVisitor Visitor;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000180
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000181 /// \brief The opaque client data, to be passed along to the visitor.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000182 CXClientData ClientData;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000183
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000184 // 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;
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000188
189 /// \brief When valid, a source range to which the cursor should restrict
190 /// its search.
191 SourceRange RegionOfInterest;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000192
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000193 // 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
Ted Kremenekd1ded662010-11-15 23:31:32 +0000198 // Cache of pre-allocated worklists for data-recursion walk of Stmts.
199 llvm::SmallVector<VisitorWorkList*, 5> WorkListFreeList;
200 llvm::SmallVector<VisitorWorkList*, 5> WorkListCache;
201
Douglas Gregorb1373d02010-01-20 20:59:29 +0000202 using DeclVisitor<CursorVisitor, bool>::Visit;
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000203 using TypeLocVisitor<CursorVisitor, bool>::Visit;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000204
205 /// \brief Determine whether this particular source range comes before, comes
206 /// after, or overlaps the region of interest.
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000207 ///
Daniel Dunbard52864b2010-02-14 10:02:57 +0000208 /// \param R a half-open source range retrieved from the abstract syntax tree.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000209 RangeComparisonResult CompareRegionOfInterest(SourceRange R);
210
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000211 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
Steve Naroff89922f82009-08-31 00:59:03 +0000232public:
Ted Kremeneka60ed472010-11-16 08:15:36 +0000233 CursorVisitor(CXTranslationUnit TU, CXCursorVisitor Visitor,
234 CXClientData ClientData,
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000235 unsigned MaxPCHLevel,
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000236 SourceRange RegionOfInterest = SourceRange())
Ted Kremeneka60ed472010-11-16 08:15:36 +0000237 : TU(TU), AU(static_cast<ASTUnit*>(TU->TUData)),
238 Visitor(Visitor), ClientData(ClientData),
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000239 MaxPCHLevel(MaxPCHLevel), RegionOfInterest(RegionOfInterest),
240 DI_current(0)
Douglas Gregorb1373d02010-01-20 20:59:29 +0000241 {
242 Parent.kind = CXCursor_NoDeclFound;
243 Parent.data[0] = 0;
244 Parent.data[1] = 0;
245 Parent.data[2] = 0;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000246 StmtParent = 0;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000247 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000248
Ted Kremenekd1ded662010-11-15 23:31:32 +0000249 ~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
Ted Kremeneka60ed472010-11-16 08:15:36 +0000257 ASTUnit *getASTUnit() const { return static_cast<ASTUnit*>(TU->TUData); }
258 CXTranslationUnit getTU() const { return TU; }
Ted Kremenekab979612010-11-11 08:05:23 +0000259
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000260 bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false);
Douglas Gregor788f5a12010-03-20 00:41:21 +0000261
262 std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
263 getPreprocessedEntities();
264
Douglas Gregorb1373d02010-01-20 20:59:29 +0000265 bool VisitChildren(CXCursor Parent);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000266
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000267 // Declaration visitors
Ted Kremenek09dfa372010-02-18 05:46:33 +0000268 bool VisitAttributes(Decl *D);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000269 bool VisitBlockDecl(BlockDecl *B);
Ted Kremenek3064ef92010-08-27 21:34:58 +0000270 bool VisitCXXRecordDecl(CXXRecordDecl *D);
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000271 llvm::Optional<bool> shouldVisitCursor(CXCursor C);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000272 bool VisitDeclContext(DeclContext *DC);
Ted Kremenek4540c9c2010-02-18 18:47:08 +0000273 bool VisitTranslationUnitDecl(TranslationUnitDecl *D);
274 bool VisitTypedefDecl(TypedefDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000275 bool VisitTagDecl(TagDecl *D);
Douglas Gregor0ab1e9f2010-09-01 17:32:36 +0000276 bool VisitClassTemplateSpecializationDecl(ClassTemplateSpecializationDecl *D);
Douglas Gregor74dbe642010-08-31 19:31:58 +0000277 bool VisitClassTemplatePartialSpecializationDecl(
278 ClassTemplatePartialSpecializationDecl *D);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000279 bool VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000280 bool VisitEnumConstantDecl(EnumConstantDecl *D);
281 bool VisitDeclaratorDecl(DeclaratorDecl *DD);
282 bool VisitFunctionDecl(FunctionDecl *ND);
283 bool VisitFieldDecl(FieldDecl *D);
Ted Kremenek4540c9c2010-02-18 18:47:08 +0000284 bool VisitVarDecl(VarDecl *);
Douglas Gregor84b51d72010-09-01 20:16:53 +0000285 bool VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000286 bool VisitFunctionTemplateDecl(FunctionTemplateDecl *D);
Douglas Gregor39d6f072010-08-31 19:02:00 +0000287 bool VisitClassTemplateDecl(ClassTemplateDecl *D);
Douglas Gregor84b51d72010-09-01 20:16:53 +0000288 bool VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000289 bool VisitObjCMethodDecl(ObjCMethodDecl *ND);
290 bool VisitObjCContainerDecl(ObjCContainerDecl *D);
291 bool VisitObjCCategoryDecl(ObjCCategoryDecl *ND);
292 bool VisitObjCProtocolDecl(ObjCProtocolDecl *PID);
Ted Kremenek23173d72010-05-18 21:09:07 +0000293 bool VisitObjCPropertyDecl(ObjCPropertyDecl *PD);
Ted Kremenek79758f62010-02-18 22:36:18 +0000294 bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
295 bool VisitObjCImplDecl(ObjCImplDecl *D);
296 bool VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
297 bool VisitObjCImplementationDecl(ObjCImplementationDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000298 // FIXME: ObjCCompatibleAliasDecl requires aliased-class locations.
299 bool VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D);
300 bool VisitObjCClassDecl(ObjCClassDecl *D);
Douglas Gregora4ffd852010-11-17 01:03:52 +0000301 bool VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PD);
Ted Kremeneka0536d82010-05-07 01:04:29 +0000302 bool VisitLinkageSpecDecl(LinkageSpecDecl *D);
Ted Kremenek8f06e0e2010-05-06 23:38:21 +0000303 bool VisitNamespaceDecl(NamespaceDecl *D);
Douglas Gregor69319002010-08-31 23:48:11 +0000304 bool VisitNamespaceAliasDecl(NamespaceAliasDecl *D);
Douglas Gregor0a35bce2010-09-01 03:07:18 +0000305 bool VisitUsingDirectiveDecl(UsingDirectiveDecl *D);
Douglas Gregor7e242562010-09-01 19:52:22 +0000306 bool VisitUsingDecl(UsingDecl *D);
307 bool VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D);
308 bool VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D);
Douglas Gregor0a35bce2010-09-01 03:07:18 +0000309
Douglas Gregor01829d32010-08-31 14:41:23 +0000310 // Name visitor
311 bool VisitDeclarationNameInfo(DeclarationNameInfo Name);
Douglas Gregorc5ade2e2010-09-02 17:35:32 +0000312 bool VisitNestedNameSpecifier(NestedNameSpecifier *NNS, SourceRange Range);
Douglas Gregor01829d32010-08-31 14:41:23 +0000313
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000314 // Template visitors
315 bool VisitTemplateParameters(const TemplateParameterList *Params);
Douglas Gregor0b36e612010-08-31 20:37:03 +0000316 bool VisitTemplateName(TemplateName Name, SourceLocation Loc);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000317 bool VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL);
318
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000319 // Type visitors
Douglas Gregor01829d32010-08-31 14:41:23 +0000320 bool VisitQualifiedTypeLoc(QualifiedTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000321 bool VisitBuiltinTypeLoc(BuiltinTypeLoc TL);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000322 bool VisitTypedefTypeLoc(TypedefTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000323 bool VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL);
324 bool VisitTagTypeLoc(TagTypeLoc TL);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000325 bool VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000326 bool VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL);
John McCallc12c5bb2010-05-15 11:32:37 +0000327 bool VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000328 bool VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL);
Abramo Bagnara075f8f12010-12-10 16:29:40 +0000329 bool VisitParenTypeLoc(ParenTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000330 bool VisitPointerTypeLoc(PointerTypeLoc TL);
331 bool VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL);
332 bool VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL);
333 bool VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL);
334 bool VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL);
Douglas Gregor01829d32010-08-31 14:41:23 +0000335 bool VisitFunctionTypeLoc(FunctionTypeLoc TL, bool SkipResultType = false);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000336 bool VisitArrayTypeLoc(ArrayTypeLoc TL);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000337 bool VisitTemplateSpecializationTypeLoc(TemplateSpecializationTypeLoc TL);
Douglas Gregor2332c112010-01-21 20:48:56 +0000338 // FIXME: Implement visitors here when the unimplemented TypeLocs get
339 // implemented
340 bool VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL);
Douglas Gregor7536dd52010-12-20 02:24:11 +0000341 bool VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL);
Douglas Gregor2332c112010-01-21 20:48:56 +0000342 bool VisitTypeOfTypeLoc(TypeOfTypeLoc TL);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000343
Ted Kremenekc0e1d922010-11-11 08:05:18 +0000344 // Data-recursive visitor functions.
345 bool IsInRegionOfInterest(CXCursor C);
346 bool RunVisitorWorkList(VisitorWorkList &WL);
347 void EnqueueWorkList(VisitorWorkList &WL, Stmt *S);
Ted Kremenekcdba6592010-11-18 00:42:18 +0000348 LLVM_ATTRIBUTE_NOINLINE bool Visit(Stmt *S);
Steve Naroff89922f82009-08-31 00:59:03 +0000349};
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000350
Ted Kremenekab188932010-01-05 19:32:54 +0000351} // end anonymous namespace
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000352
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000353static SourceRange getRawCursorExtent(CXCursor C);
Douglas Gregor66537982010-11-17 17:14:07 +0000354static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr);
355
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000356
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000357RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
Ted Kremeneka60ed472010-11-16 08:15:36 +0000358 return RangeCompare(AU->getSourceManager(), R, RegionOfInterest);
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000359}
360
Douglas Gregorb1373d02010-01-20 20:59:29 +0000361/// \brief Visit the given cursor and, if requested by the visitor,
362/// its children.
363///
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000364/// \param Cursor the cursor to visit.
365///
366/// \param CheckRegionOfInterest if true, then the caller already checked that
367/// this cursor is within the region of interest.
368///
Douglas Gregorb1373d02010-01-20 20:59:29 +0000369/// \returns true if the visitation should be aborted, false if it
370/// should continue.
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000371bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
Douglas Gregorb1373d02010-01-20 20:59:29 +0000372 if (clang_isInvalid(Cursor.kind))
373 return false;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000374
Douglas Gregorb1373d02010-01-20 20:59:29 +0000375 if (clang_isDeclaration(Cursor.kind)) {
376 Decl *D = getCursorDecl(Cursor);
377 assert(D && "Invalid declaration cursor");
378 if (D->getPCHLevel() > MaxPCHLevel)
379 return false;
380
381 if (D->isImplicit())
382 return false;
383 }
384
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000385 // If we have a range of interest, and this cursor doesn't intersect with it,
386 // we're done.
387 if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000388 SourceRange Range = getRawCursorExtent(Cursor);
Daniel Dunbarf408f322010-02-14 08:32:05 +0000389 if (Range.isInvalid() || CompareRegionOfInterest(Range))
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000390 return false;
391 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000392
Douglas Gregorb1373d02010-01-20 20:59:29 +0000393 switch (Visitor(Cursor, Parent, ClientData)) {
394 case CXChildVisit_Break:
395 return true;
396
397 case CXChildVisit_Continue:
398 return false;
399
400 case CXChildVisit_Recurse:
401 return VisitChildren(Cursor);
402 }
403
Douglas Gregorfd643772010-01-25 16:45:46 +0000404 return false;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000405}
406
Douglas Gregor788f5a12010-03-20 00:41:21 +0000407std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
408CursorVisitor::getPreprocessedEntities() {
409 PreprocessingRecord &PPRec
Ted Kremeneka60ed472010-11-16 08:15:36 +0000410 = *AU->getPreprocessor().getPreprocessingRecord();
Douglas Gregor788f5a12010-03-20 00:41:21 +0000411
412 bool OnlyLocalDecls
Douglas Gregor32038bb2010-12-21 19:07:48 +0000413 = !AU->isMainFileAST() && AU->getOnlyLocalDecls();
414
415 if (OnlyLocalDecls && RegionOfInterest.isValid()) {
416 // If we would only look at local declarations but we have a region of
417 // interest, check whether that region of interest is in the main file.
418 // If not, we should traverse all declarations.
419 // FIXME: My kingdom for a proper binary search approach to finding
420 // cursors!
421 std::pair<FileID, unsigned> Location
422 = AU->getSourceManager().getDecomposedInstantiationLoc(
423 RegionOfInterest.getBegin());
424 if (Location.first != AU->getSourceManager().getMainFileID())
425 OnlyLocalDecls = false;
426 }
Douglas Gregor788f5a12010-03-20 00:41:21 +0000427
Douglas Gregor89d99802010-11-30 06:16:57 +0000428 PreprocessingRecord::iterator StartEntity, EndEntity;
429 if (OnlyLocalDecls) {
430 StartEntity = AU->pp_entity_begin();
431 EndEntity = AU->pp_entity_end();
432 } else {
433 StartEntity = PPRec.begin();
434 EndEntity = PPRec.end();
435 }
436
Douglas Gregor788f5a12010-03-20 00:41:21 +0000437 // There is no region of interest; we have to walk everything.
438 if (RegionOfInterest.isInvalid())
Douglas Gregor89d99802010-11-30 06:16:57 +0000439 return std::make_pair(StartEntity, EndEntity);
Douglas Gregor788f5a12010-03-20 00:41:21 +0000440
441 // Find the file in which the region of interest lands.
Ted Kremeneka60ed472010-11-16 08:15:36 +0000442 SourceManager &SM = AU->getSourceManager();
Douglas Gregor788f5a12010-03-20 00:41:21 +0000443 std::pair<FileID, unsigned> Begin
444 = SM.getDecomposedInstantiationLoc(RegionOfInterest.getBegin());
445 std::pair<FileID, unsigned> End
446 = SM.getDecomposedInstantiationLoc(RegionOfInterest.getEnd());
447
448 // The region of interest spans files; we have to walk everything.
449 if (Begin.first != End.first)
Douglas Gregor89d99802010-11-30 06:16:57 +0000450 return std::make_pair(StartEntity, EndEntity);
Douglas Gregor788f5a12010-03-20 00:41:21 +0000451
452 ASTUnit::PreprocessedEntitiesByFileMap &ByFileMap
Ted Kremeneka60ed472010-11-16 08:15:36 +0000453 = AU->getPreprocessedEntitiesByFile();
Douglas Gregor788f5a12010-03-20 00:41:21 +0000454 if (ByFileMap.empty()) {
455 // Build the mapping from files to sets of preprocessed entities.
Douglas Gregor89d99802010-11-30 06:16:57 +0000456 for (PreprocessingRecord::iterator E = StartEntity; E != EndEntity; ++E) {
Douglas Gregor788f5a12010-03-20 00:41:21 +0000457 std::pair<FileID, unsigned> P
458 = SM.getDecomposedInstantiationLoc((*E)->getSourceRange().getBegin());
Douglas Gregor89d99802010-11-30 06:16:57 +0000459
Douglas Gregor788f5a12010-03-20 00:41:21 +0000460 ByFileMap[P.first].push_back(*E);
461 }
462 }
463
464 return std::make_pair(ByFileMap[Begin.first].begin(),
465 ByFileMap[Begin.first].end());
466}
467
Douglas Gregorb1373d02010-01-20 20:59:29 +0000468/// \brief Visit the children of the given cursor.
Ted Kremeneka60ed472010-11-16 08:15:36 +0000469///
Douglas Gregorb1373d02010-01-20 20:59:29 +0000470/// \returns true if the visitation should be aborted, false if it
471/// should continue.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000472bool CursorVisitor::VisitChildren(CXCursor Cursor) {
Douglas Gregora59e3902010-01-21 23:27:09 +0000473 if (clang_isReference(Cursor.kind)) {
474 // By definition, references have no children.
475 return false;
476 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000477
478 // Set the Parent field to Cursor, then back to its old value once we're
Douglas Gregorb1373d02010-01-20 20:59:29 +0000479 // done.
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000480 SetParentRAII SetParent(Parent, StmtParent, Cursor);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000481
Douglas Gregorb1373d02010-01-20 20:59:29 +0000482 if (clang_isDeclaration(Cursor.kind)) {
483 Decl *D = getCursorDecl(Cursor);
484 assert(D && "Invalid declaration cursor");
Ted Kremenek539311e2010-02-18 18:47:01 +0000485 return VisitAttributes(D) || Visit(D);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000486 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000487
Douglas Gregora59e3902010-01-21 23:27:09 +0000488 if (clang_isStatement(Cursor.kind))
489 return Visit(getCursorStmt(Cursor));
490 if (clang_isExpression(Cursor.kind))
491 return Visit(getCursorExpr(Cursor));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000492
Douglas Gregorb1373d02010-01-20 20:59:29 +0000493 if (clang_isTranslationUnit(Cursor.kind)) {
Ted Kremeneka60ed472010-11-16 08:15:36 +0000494 CXTranslationUnit tu = getCursorTU(Cursor);
495 ASTUnit *CXXUnit = static_cast<ASTUnit*>(tu->TUData);
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000496 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() &&
497 RegionOfInterest.isInvalid()) {
Douglas Gregoreb8837b2010-08-03 19:06:41 +0000498 for (ASTUnit::top_level_iterator TL = CXXUnit->top_level_begin(),
499 TLEnd = CXXUnit->top_level_end();
500 TL != TLEnd; ++TL) {
Ted Kremeneka60ed472010-11-16 08:15:36 +0000501 if (Visit(MakeCXCursor(*TL, tu), true))
Douglas Gregor7b691f332010-01-20 21:13:59 +0000502 return true;
503 }
Douglas Gregor0396f462010-03-19 05:22:59 +0000504 } else if (VisitDeclContext(
505 CXXUnit->getASTContext().getTranslationUnitDecl()))
506 return true;
Bob Wilson3178cb62010-03-19 03:57:57 +0000507
Douglas Gregor0396f462010-03-19 05:22:59 +0000508 // Walk the preprocessing record.
Daniel Dunbar8de30ff2010-03-20 01:11:56 +0000509 if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
Douglas Gregor0396f462010-03-19 05:22:59 +0000510 // FIXME: Once we have the ability to deserialize a preprocessing record,
511 // do so.
Douglas Gregor788f5a12010-03-20 00:41:21 +0000512 PreprocessingRecord::iterator E, EEnd;
513 for (llvm::tie(E, EEnd) = getPreprocessedEntities(); E != EEnd; ++E) {
Douglas Gregor0396f462010-03-19 05:22:59 +0000514 if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) {
Ted Kremeneka60ed472010-11-16 08:15:36 +0000515 if (Visit(MakeMacroInstantiationCursor(MI, tu)))
Douglas Gregor0396f462010-03-19 05:22:59 +0000516 return true;
Douglas Gregor788f5a12010-03-20 00:41:21 +0000517
Douglas Gregor0396f462010-03-19 05:22:59 +0000518 continue;
519 }
520
521 if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
Ted Kremeneka60ed472010-11-16 08:15:36 +0000522 if (Visit(MakeMacroDefinitionCursor(MD, tu)))
Douglas Gregor0396f462010-03-19 05:22:59 +0000523 return true;
524
525 continue;
526 }
Douglas Gregorecdcb882010-10-20 22:00:55 +0000527
528 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(*E)) {
Ted Kremeneka60ed472010-11-16 08:15:36 +0000529 if (Visit(MakeInclusionDirectiveCursor(ID, tu)))
Douglas Gregorecdcb882010-10-20 22:00:55 +0000530 return true;
531
532 continue;
533 }
Douglas Gregor0396f462010-03-19 05:22:59 +0000534 }
535 }
Douglas Gregor7b691f332010-01-20 21:13:59 +0000536 return false;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000537 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000538
Douglas Gregorb1373d02010-01-20 20:59:29 +0000539 // Nothing to visit at the moment.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000540 return false;
541}
542
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000543bool CursorVisitor::VisitBlockDecl(BlockDecl *B) {
John McCallfc929202010-06-04 22:33:30 +0000544 if (Visit(B->getSignatureAsWritten()->getTypeLoc()))
545 return true;
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000546
Ted Kremenek664cffd2010-07-22 11:30:19 +0000547 if (Stmt *Body = B->getBody())
548 return Visit(MakeCXCursor(Body, StmtParent, TU));
549
550 return false;
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000551}
552
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000553llvm::Optional<bool> CursorVisitor::shouldVisitCursor(CXCursor Cursor) {
554 if (RegionOfInterest.isValid()) {
Douglas Gregor66537982010-11-17 17:14:07 +0000555 SourceRange Range = getFullCursorExtent(Cursor, AU->getSourceManager());
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000556 if (Range.isInvalid())
557 return llvm::Optional<bool>();
Douglas Gregor66537982010-11-17 17:14:07 +0000558
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000559 switch (CompareRegionOfInterest(Range)) {
560 case RangeBefore:
561 // This declaration comes before the region of interest; skip it.
562 return llvm::Optional<bool>();
563
564 case RangeAfter:
565 // This declaration comes after the region of interest; we're done.
566 return false;
567
568 case RangeOverlap:
569 // This declaration overlaps the region of interest; visit it.
570 break;
571 }
572 }
573 return true;
574}
575
576bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
577 DeclContext::decl_iterator I = DC->decls_begin(), E = DC->decls_end();
578
579 // FIXME: Eventually remove. This part of a hack to support proper
580 // iteration over all Decls contained lexically within an ObjC container.
581 SaveAndRestore<DeclContext::decl_iterator*> DI_saved(DI_current, &I);
582 SaveAndRestore<DeclContext::decl_iterator> DE_saved(DE_current, E);
583
584 for ( ; I != E; ++I) {
Ted Kremenek23173d72010-05-18 21:09:07 +0000585 Decl *D = *I;
586 if (D->getLexicalDeclContext() != DC)
587 continue;
Ted Kremenek23173d72010-05-18 21:09:07 +0000588 CXCursor Cursor = MakeCXCursor(D, TU);
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000589 const llvm::Optional<bool> &V = shouldVisitCursor(Cursor);
590 if (!V.hasValue())
591 continue;
592 if (!V.getValue())
593 return false;
Daniel Dunbard52864b2010-02-14 10:02:57 +0000594 if (Visit(Cursor, true))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000595 return true;
596 }
Douglas Gregorb1373d02010-01-20 20:59:29 +0000597 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000598}
599
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000600bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
601 llvm_unreachable("Translation units are visited directly by Visit()");
602 return false;
603}
604
605bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
606 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
607 return Visit(TSInfo->getTypeLoc());
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000608
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000609 return false;
610}
611
612bool CursorVisitor::VisitTagDecl(TagDecl *D) {
613 return VisitDeclContext(D);
614}
615
Douglas Gregor0ab1e9f2010-09-01 17:32:36 +0000616bool CursorVisitor::VisitClassTemplateSpecializationDecl(
617 ClassTemplateSpecializationDecl *D) {
618 bool ShouldVisitBody = false;
619 switch (D->getSpecializationKind()) {
620 case TSK_Undeclared:
621 case TSK_ImplicitInstantiation:
622 // Nothing to visit
623 return false;
624
625 case TSK_ExplicitInstantiationDeclaration:
626 case TSK_ExplicitInstantiationDefinition:
627 break;
628
629 case TSK_ExplicitSpecialization:
630 ShouldVisitBody = true;
631 break;
632 }
633
634 // Visit the template arguments used in the specialization.
635 if (TypeSourceInfo *SpecType = D->getTypeAsWritten()) {
636 TypeLoc TL = SpecType->getTypeLoc();
637 if (TemplateSpecializationTypeLoc *TSTLoc
638 = dyn_cast<TemplateSpecializationTypeLoc>(&TL)) {
639 for (unsigned I = 0, N = TSTLoc->getNumArgs(); I != N; ++I)
640 if (VisitTemplateArgumentLoc(TSTLoc->getArgLoc(I)))
641 return true;
642 }
643 }
644
645 if (ShouldVisitBody && VisitCXXRecordDecl(D))
646 return true;
647
648 return false;
649}
650
Douglas Gregor74dbe642010-08-31 19:31:58 +0000651bool CursorVisitor::VisitClassTemplatePartialSpecializationDecl(
652 ClassTemplatePartialSpecializationDecl *D) {
653 // FIXME: Visit the "outer" template parameter lists on the TagDecl
654 // before visiting these template parameters.
655 if (VisitTemplateParameters(D->getTemplateParameters()))
656 return true;
657
658 // Visit the partial specialization arguments.
659 const TemplateArgumentLoc *TemplateArgs = D->getTemplateArgsAsWritten();
660 for (unsigned I = 0, N = D->getNumTemplateArgsAsWritten(); I != N; ++I)
661 if (VisitTemplateArgumentLoc(TemplateArgs[I]))
662 return true;
663
664 return VisitCXXRecordDecl(D);
665}
666
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000667bool CursorVisitor::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
Douglas Gregor84b51d72010-09-01 20:16:53 +0000668 // Visit the default argument.
669 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
670 if (TypeSourceInfo *DefArg = D->getDefaultArgumentInfo())
671 if (Visit(DefArg->getTypeLoc()))
672 return true;
673
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000674 return false;
675}
676
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000677bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
678 if (Expr *Init = D->getInitExpr())
679 return Visit(MakeCXCursor(Init, StmtParent, TU));
680 return false;
681}
682
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000683bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
684 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
685 if (Visit(TSInfo->getTypeLoc()))
686 return true;
687
688 return false;
689}
690
Douglas Gregora67e03f2010-09-09 21:42:20 +0000691/// \brief Compare two base or member initializers based on their source order.
692static int CompareCXXBaseOrMemberInitializers(const void* Xp, const void *Yp) {
693 CXXBaseOrMemberInitializer const * const *X
694 = static_cast<CXXBaseOrMemberInitializer const * const *>(Xp);
695 CXXBaseOrMemberInitializer const * const *Y
696 = static_cast<CXXBaseOrMemberInitializer const * const *>(Yp);
697
698 if ((*X)->getSourceOrder() < (*Y)->getSourceOrder())
699 return -1;
700 else if ((*X)->getSourceOrder() > (*Y)->getSourceOrder())
701 return 1;
702 else
703 return 0;
704}
705
Douglas Gregorb1373d02010-01-20 20:59:29 +0000706bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
Douglas Gregor01829d32010-08-31 14:41:23 +0000707 if (TypeSourceInfo *TSInfo = ND->getTypeSourceInfo()) {
708 // Visit the function declaration's syntactic components in the order
709 // written. This requires a bit of work.
Abramo Bagnara723df242010-12-14 22:11:44 +0000710 TypeLoc TL = TSInfo->getTypeLoc().IgnoreParens();
Douglas Gregor01829d32010-08-31 14:41:23 +0000711 FunctionTypeLoc *FTL = dyn_cast<FunctionTypeLoc>(&TL);
712
713 // If we have a function declared directly (without the use of a typedef),
714 // visit just the return type. Otherwise, just visit the function's type
715 // now.
716 if ((FTL && !isa<CXXConversionDecl>(ND) && Visit(FTL->getResultLoc())) ||
717 (!FTL && Visit(TL)))
718 return true;
719
Douglas Gregorc5ade2e2010-09-02 17:35:32 +0000720 // Visit the nested-name-specifier, if present.
721 if (NestedNameSpecifier *Qualifier = ND->getQualifier())
722 if (VisitNestedNameSpecifier(Qualifier, ND->getQualifierRange()))
723 return true;
Douglas Gregor01829d32010-08-31 14:41:23 +0000724
725 // Visit the declaration name.
726 if (VisitDeclarationNameInfo(ND->getNameInfo()))
727 return true;
728
729 // FIXME: Visit explicitly-specified template arguments!
730
731 // Visit the function parameters, if we have a function type.
732 if (FTL && VisitFunctionTypeLoc(*FTL, true))
733 return true;
734
735 // FIXME: Attributes?
736 }
737
Douglas Gregora67e03f2010-09-09 21:42:20 +0000738 if (ND->isThisDeclarationADefinition()) {
739 if (CXXConstructorDecl *Constructor = dyn_cast<CXXConstructorDecl>(ND)) {
740 // Find the initializers that were written in the source.
741 llvm::SmallVector<CXXBaseOrMemberInitializer *, 4> WrittenInits;
742 for (CXXConstructorDecl::init_iterator I = Constructor->init_begin(),
743 IEnd = Constructor->init_end();
744 I != IEnd; ++I) {
745 if (!(*I)->isWritten())
746 continue;
747
748 WrittenInits.push_back(*I);
749 }
750
751 // Sort the initializers in source order
752 llvm::array_pod_sort(WrittenInits.begin(), WrittenInits.end(),
753 &CompareCXXBaseOrMemberInitializers);
754
755 // Visit the initializers in source order
756 for (unsigned I = 0, N = WrittenInits.size(); I != N; ++I) {
757 CXXBaseOrMemberInitializer *Init = WrittenInits[I];
Francois Pichet00eb3f92010-12-04 09:14:42 +0000758 if (Init->isAnyMemberInitializer()) {
759 if (Visit(MakeCursorMemberRef(Init->getAnyMember(),
Douglas Gregora67e03f2010-09-09 21:42:20 +0000760 Init->getMemberLocation(), TU)))
761 return true;
762 } else if (TypeSourceInfo *BaseInfo = Init->getBaseClassInfo()) {
763 if (Visit(BaseInfo->getTypeLoc()))
764 return true;
765 }
766
767 // Visit the initializer value.
768 if (Expr *Initializer = Init->getInit())
769 if (Visit(MakeCXCursor(Initializer, ND, TU)))
770 return true;
771 }
772 }
773
774 if (Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
775 return true;
776 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000777
Douglas Gregorb1373d02010-01-20 20:59:29 +0000778 return false;
779}
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000780
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000781bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
782 if (VisitDeclaratorDecl(D))
783 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000784
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000785 if (Expr *BitWidth = D->getBitWidth())
786 return Visit(MakeCXCursor(BitWidth, StmtParent, TU));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000787
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000788 return false;
789}
790
791bool CursorVisitor::VisitVarDecl(VarDecl *D) {
792 if (VisitDeclaratorDecl(D))
793 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000794
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000795 if (Expr *Init = D->getInit())
796 return Visit(MakeCXCursor(Init, StmtParent, TU));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000797
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000798 return false;
799}
800
Douglas Gregor84b51d72010-09-01 20:16:53 +0000801bool CursorVisitor::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
802 if (VisitDeclaratorDecl(D))
803 return true;
804
805 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
806 if (Expr *DefArg = D->getDefaultArgument())
807 return Visit(MakeCXCursor(DefArg, StmtParent, TU));
808
809 return false;
810}
811
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000812bool CursorVisitor::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
813 // FIXME: Visit the "outer" template parameter lists on the FunctionDecl
814 // before visiting these template parameters.
815 if (VisitTemplateParameters(D->getTemplateParameters()))
816 return true;
817
818 return VisitFunctionDecl(D->getTemplatedDecl());
819}
820
Douglas Gregor39d6f072010-08-31 19:02:00 +0000821bool CursorVisitor::VisitClassTemplateDecl(ClassTemplateDecl *D) {
822 // FIXME: Visit the "outer" template parameter lists on the TagDecl
823 // before visiting these template parameters.
824 if (VisitTemplateParameters(D->getTemplateParameters()))
825 return true;
826
827 return VisitCXXRecordDecl(D->getTemplatedDecl());
828}
829
Douglas Gregor84b51d72010-09-01 20:16:53 +0000830bool CursorVisitor::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
831 if (VisitTemplateParameters(D->getTemplateParameters()))
832 return true;
833
834 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited() &&
835 VisitTemplateArgumentLoc(D->getDefaultArgument()))
836 return true;
837
838 return false;
839}
840
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000841bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
Douglas Gregor4bc1cb62010-03-08 14:59:44 +0000842 if (TypeSourceInfo *TSInfo = ND->getResultTypeSourceInfo())
843 if (Visit(TSInfo->getTypeLoc()))
844 return true;
845
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000846 for (ObjCMethodDecl::param_iterator P = ND->param_begin(),
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000847 PEnd = ND->param_end();
848 P != PEnd; ++P) {
849 if (Visit(MakeCXCursor(*P, TU)))
850 return true;
851 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000852
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000853 if (ND->isThisDeclarationADefinition() &&
854 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
855 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000856
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000857 return false;
858}
859
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000860namespace {
861 struct ContainerDeclsSort {
862 SourceManager &SM;
863 ContainerDeclsSort(SourceManager &sm) : SM(sm) {}
864 bool operator()(Decl *A, Decl *B) {
865 SourceLocation L_A = A->getLocStart();
866 SourceLocation L_B = B->getLocStart();
867 assert(L_A.isValid() && L_B.isValid());
868 return SM.isBeforeInTranslationUnit(L_A, L_B);
869 }
870 };
871}
872
Douglas Gregora59e3902010-01-21 23:27:09 +0000873bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000874 // FIXME: Eventually convert back to just 'VisitDeclContext()'. Essentially
875 // an @implementation can lexically contain Decls that are not properly
876 // nested in the AST. When we identify such cases, we need to retrofit
877 // this nesting here.
878 if (!DI_current)
879 return VisitDeclContext(D);
880
881 // Scan the Decls that immediately come after the container
882 // in the current DeclContext. If any fall within the
883 // container's lexical region, stash them into a vector
884 // for later processing.
885 llvm::SmallVector<Decl *, 24> DeclsInContainer;
886 SourceLocation EndLoc = D->getSourceRange().getEnd();
Ted Kremeneka60ed472010-11-16 08:15:36 +0000887 SourceManager &SM = AU->getSourceManager();
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000888 if (EndLoc.isValid()) {
889 DeclContext::decl_iterator next = *DI_current;
890 while (++next != DE_current) {
891 Decl *D_next = *next;
892 if (!D_next)
893 break;
894 SourceLocation L = D_next->getLocStart();
895 if (!L.isValid())
896 break;
897 if (SM.isBeforeInTranslationUnit(L, EndLoc)) {
898 *DI_current = next;
899 DeclsInContainer.push_back(D_next);
900 continue;
901 }
902 break;
903 }
904 }
905
906 // The common case.
907 if (DeclsInContainer.empty())
908 return VisitDeclContext(D);
909
910 // Get all the Decls in the DeclContext, and sort them with the
911 // additional ones we've collected. Then visit them.
912 for (DeclContext::decl_iterator I = D->decls_begin(), E = D->decls_end();
913 I!=E; ++I) {
914 Decl *subDecl = *I;
Ted Kremenek0582c892010-11-02 23:17:51 +0000915 if (!subDecl || subDecl->getLexicalDeclContext() != D ||
916 subDecl->getLocStart().isInvalid())
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000917 continue;
918 DeclsInContainer.push_back(subDecl);
919 }
920
921 // Now sort the Decls so that they appear in lexical order.
922 std::sort(DeclsInContainer.begin(), DeclsInContainer.end(),
923 ContainerDeclsSort(SM));
924
925 // Now visit the decls.
926 for (llvm::SmallVectorImpl<Decl*>::iterator I = DeclsInContainer.begin(),
927 E = DeclsInContainer.end(); I != E; ++I) {
928 CXCursor Cursor = MakeCXCursor(*I, TU);
929 const llvm::Optional<bool> &V = shouldVisitCursor(Cursor);
930 if (!V.hasValue())
931 continue;
932 if (!V.getValue())
933 return false;
934 if (Visit(Cursor, true))
935 return true;
936 }
937 return false;
Douglas Gregora59e3902010-01-21 23:27:09 +0000938}
939
Douglas Gregorb1373d02010-01-20 20:59:29 +0000940bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000941 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
942 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000943 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000944
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000945 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
946 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
947 E = ND->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000948 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000949 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000950
Douglas Gregora59e3902010-01-21 23:27:09 +0000951 return VisitObjCContainerDecl(ND);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000952}
953
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000954bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
955 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
956 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
957 E = PID->protocol_end(); I != E; ++I, ++PL)
958 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
959 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000960
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000961 return VisitObjCContainerDecl(PID);
962}
963
Ted Kremenek23173d72010-05-18 21:09:07 +0000964bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
Douglas Gregor83cb9422010-09-09 17:09:21 +0000965 if (PD->getTypeSourceInfo() && Visit(PD->getTypeSourceInfo()->getTypeLoc()))
John McCallfc929202010-06-04 22:33:30 +0000966 return true;
967
Ted Kremenek23173d72010-05-18 21:09:07 +0000968 // FIXME: This implements a workaround with @property declarations also being
969 // installed in the DeclContext for the @interface. Eventually this code
970 // should be removed.
971 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
972 if (!CDecl || !CDecl->IsClassExtension())
973 return false;
974
975 ObjCInterfaceDecl *ID = CDecl->getClassInterface();
976 if (!ID)
977 return false;
978
979 IdentifierInfo *PropertyId = PD->getIdentifier();
980 ObjCPropertyDecl *prevDecl =
981 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId);
982
983 if (!prevDecl)
984 return false;
985
986 // Visit synthesized methods since they will be skipped when visiting
987 // the @interface.
988 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
Ted Kremeneka054fb42010-09-21 20:52:59 +0000989 if (MD->isSynthesized() && MD->getLexicalDeclContext() == CDecl)
Ted Kremenek23173d72010-05-18 21:09:07 +0000990 if (Visit(MakeCXCursor(MD, TU)))
991 return true;
992
993 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
Ted Kremeneka054fb42010-09-21 20:52:59 +0000994 if (MD->isSynthesized() && MD->getLexicalDeclContext() == CDecl)
Ted Kremenek23173d72010-05-18 21:09:07 +0000995 if (Visit(MakeCXCursor(MD, TU)))
996 return true;
997
998 return false;
999}
1000
Douglas Gregorb1373d02010-01-20 20:59:29 +00001001bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
Ted Kremenekdd6bcc52010-01-13 00:22:49 +00001002 // Issue callbacks for super class.
Douglas Gregorb1373d02010-01-20 20:59:29 +00001003 if (D->getSuperClass() &&
1004 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001005 D->getSuperClassLoc(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001006 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +00001007 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001008
Douglas Gregor78db0cd2010-01-16 15:44:18 +00001009 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
1010 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
1011 E = D->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001012 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +00001013 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001014
Douglas Gregora59e3902010-01-21 23:27:09 +00001015 return VisitObjCContainerDecl(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +00001016}
1017
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001018bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
1019 return VisitObjCContainerDecl(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +00001020}
1021
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001022bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
Ted Kremenekebfa3392010-03-19 20:39:03 +00001023 // 'ID' could be null when dealing with invalid code.
1024 if (ObjCInterfaceDecl *ID = D->getClassInterface())
1025 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
1026 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001027
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001028 return VisitObjCImplDecl(D);
1029}
1030
1031bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
1032#if 0
1033 // Issue callbacks for super class.
1034 // FIXME: No source location information!
1035 if (D->getSuperClass() &&
1036 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001037 D->getSuperClassLoc(),
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001038 TU)))
1039 return true;
1040#endif
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001041
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001042 return VisitObjCImplDecl(D);
1043}
1044
1045bool CursorVisitor::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
1046 ObjCForwardProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
1047 for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(),
1048 E = D->protocol_end();
1049 I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001050 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +00001051 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001052
1053 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +00001054}
1055
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001056bool CursorVisitor::VisitObjCClassDecl(ObjCClassDecl *D) {
1057 for (ObjCClassDecl::iterator C = D->begin(), CEnd = D->end(); C != CEnd; ++C)
1058 if (Visit(MakeCursorObjCClassRef(C->getInterface(), C->getLocation(), TU)))
1059 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001060
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001061 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +00001062}
1063
Douglas Gregora4ffd852010-11-17 01:03:52 +00001064bool CursorVisitor::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PD) {
1065 if (ObjCIvarDecl *Ivar = PD->getPropertyIvarDecl())
1066 return Visit(MakeCursorMemberRef(Ivar, PD->getPropertyIvarDeclLoc(), TU));
1067
1068 return false;
1069}
1070
Ted Kremenek8f06e0e2010-05-06 23:38:21 +00001071bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
1072 return VisitDeclContext(D);
1073}
1074
Douglas Gregor69319002010-08-31 23:48:11 +00001075bool CursorVisitor::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001076 // Visit nested-name-specifier.
1077 if (NestedNameSpecifier *Qualifier = D->getQualifier())
1078 if (VisitNestedNameSpecifier(Qualifier, D->getQualifierRange()))
1079 return true;
Douglas Gregor69319002010-08-31 23:48:11 +00001080
1081 return Visit(MakeCursorNamespaceRef(D->getAliasedNamespace(),
1082 D->getTargetNameLoc(), TU));
1083}
1084
Douglas Gregor7e242562010-09-01 19:52:22 +00001085bool CursorVisitor::VisitUsingDecl(UsingDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001086 // Visit nested-name-specifier.
1087 if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameDecl())
1088 if (VisitNestedNameSpecifier(Qualifier, D->getNestedNameRange()))
1089 return true;
Douglas Gregor7e242562010-09-01 19:52:22 +00001090
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00001091 if (Visit(MakeCursorOverloadedDeclRef(D, D->getLocation(), TU)))
1092 return true;
1093
Douglas Gregor7e242562010-09-01 19:52:22 +00001094 return VisitDeclarationNameInfo(D->getNameInfo());
1095}
1096
Douglas Gregor0a35bce2010-09-01 03:07:18 +00001097bool CursorVisitor::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001098 // Visit nested-name-specifier.
1099 if (NestedNameSpecifier *Qualifier = D->getQualifier())
1100 if (VisitNestedNameSpecifier(Qualifier, D->getQualifierRange()))
1101 return true;
Douglas Gregor0a35bce2010-09-01 03:07:18 +00001102
1103 return Visit(MakeCursorNamespaceRef(D->getNominatedNamespaceAsWritten(),
1104 D->getIdentLocation(), TU));
1105}
1106
Douglas Gregor7e242562010-09-01 19:52:22 +00001107bool CursorVisitor::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001108 // Visit nested-name-specifier.
1109 if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameSpecifier())
1110 if (VisitNestedNameSpecifier(Qualifier, D->getTargetNestedNameRange()))
1111 return true;
1112
Douglas Gregor7e242562010-09-01 19:52:22 +00001113 return VisitDeclarationNameInfo(D->getNameInfo());
1114}
1115
1116bool CursorVisitor::VisitUnresolvedUsingTypenameDecl(
1117 UnresolvedUsingTypenameDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001118 // Visit nested-name-specifier.
1119 if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameSpecifier())
1120 if (VisitNestedNameSpecifier(Qualifier, D->getTargetNestedNameRange()))
1121 return true;
1122
Douglas Gregor7e242562010-09-01 19:52:22 +00001123 return false;
1124}
1125
Douglas Gregor01829d32010-08-31 14:41:23 +00001126bool CursorVisitor::VisitDeclarationNameInfo(DeclarationNameInfo Name) {
1127 switch (Name.getName().getNameKind()) {
1128 case clang::DeclarationName::Identifier:
1129 case clang::DeclarationName::CXXLiteralOperatorName:
1130 case clang::DeclarationName::CXXOperatorName:
1131 case clang::DeclarationName::CXXUsingDirective:
1132 return false;
1133
1134 case clang::DeclarationName::CXXConstructorName:
1135 case clang::DeclarationName::CXXDestructorName:
1136 case clang::DeclarationName::CXXConversionFunctionName:
1137 if (TypeSourceInfo *TSInfo = Name.getNamedTypeInfo())
1138 return Visit(TSInfo->getTypeLoc());
1139 return false;
1140
1141 case clang::DeclarationName::ObjCZeroArgSelector:
1142 case clang::DeclarationName::ObjCOneArgSelector:
1143 case clang::DeclarationName::ObjCMultiArgSelector:
1144 // FIXME: Per-identifier location info?
1145 return false;
1146 }
1147
1148 return false;
1149}
1150
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001151bool CursorVisitor::VisitNestedNameSpecifier(NestedNameSpecifier *NNS,
1152 SourceRange Range) {
1153 // FIXME: This whole routine is a hack to work around the lack of proper
1154 // source information in nested-name-specifiers (PR5791). Since we do have
1155 // a beginning source location, we can visit the first component of the
1156 // nested-name-specifier, if it's a single-token component.
1157 if (!NNS)
1158 return false;
1159
1160 // Get the first component in the nested-name-specifier.
1161 while (NestedNameSpecifier *Prefix = NNS->getPrefix())
1162 NNS = Prefix;
1163
1164 switch (NNS->getKind()) {
1165 case NestedNameSpecifier::Namespace:
1166 // FIXME: The token at this source location might actually have been a
1167 // namespace alias, but we don't model that. Lame!
1168 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(), Range.getBegin(),
1169 TU));
1170
1171 case NestedNameSpecifier::TypeSpec: {
1172 // If the type has a form where we know that the beginning of the source
1173 // range matches up with a reference cursor. Visit the appropriate reference
1174 // cursor.
1175 Type *T = NNS->getAsType();
1176 if (const TypedefType *Typedef = dyn_cast<TypedefType>(T))
1177 return Visit(MakeCursorTypeRef(Typedef->getDecl(), Range.getBegin(), TU));
1178 if (const TagType *Tag = dyn_cast<TagType>(T))
1179 return Visit(MakeCursorTypeRef(Tag->getDecl(), Range.getBegin(), TU));
1180 if (const TemplateSpecializationType *TST
1181 = dyn_cast<TemplateSpecializationType>(T))
1182 return VisitTemplateName(TST->getTemplateName(), Range.getBegin());
1183 break;
1184 }
1185
1186 case NestedNameSpecifier::TypeSpecWithTemplate:
1187 case NestedNameSpecifier::Global:
1188 case NestedNameSpecifier::Identifier:
1189 break;
1190 }
1191
1192 return false;
1193}
1194
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001195bool CursorVisitor::VisitTemplateParameters(
1196 const TemplateParameterList *Params) {
1197 if (!Params)
1198 return false;
1199
1200 for (TemplateParameterList::const_iterator P = Params->begin(),
1201 PEnd = Params->end();
1202 P != PEnd; ++P) {
1203 if (Visit(MakeCXCursor(*P, TU)))
1204 return true;
1205 }
1206
1207 return false;
1208}
1209
Douglas Gregor0b36e612010-08-31 20:37:03 +00001210bool CursorVisitor::VisitTemplateName(TemplateName Name, SourceLocation Loc) {
1211 switch (Name.getKind()) {
1212 case TemplateName::Template:
1213 return Visit(MakeCursorTemplateRef(Name.getAsTemplateDecl(), Loc, TU));
1214
1215 case TemplateName::OverloadedTemplate:
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00001216 // Visit the overloaded template set.
1217 if (Visit(MakeCursorOverloadedDeclRef(Name, Loc, TU)))
1218 return true;
1219
Douglas Gregor0b36e612010-08-31 20:37:03 +00001220 return false;
1221
1222 case TemplateName::DependentTemplate:
1223 // FIXME: Visit nested-name-specifier.
1224 return false;
1225
1226 case TemplateName::QualifiedTemplate:
1227 // FIXME: Visit nested-name-specifier.
1228 return Visit(MakeCursorTemplateRef(
1229 Name.getAsQualifiedTemplateName()->getDecl(),
1230 Loc, TU));
1231 }
1232
1233 return false;
1234}
1235
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001236bool CursorVisitor::VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL) {
1237 switch (TAL.getArgument().getKind()) {
1238 case TemplateArgument::Null:
1239 case TemplateArgument::Integral:
Douglas Gregor87dd6972010-12-20 16:52:59 +00001240 case TemplateArgument::Pack:
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001241 return false;
1242
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001243 case TemplateArgument::Type:
1244 if (TypeSourceInfo *TSInfo = TAL.getTypeSourceInfo())
1245 return Visit(TSInfo->getTypeLoc());
1246 return false;
1247
1248 case TemplateArgument::Declaration:
1249 if (Expr *E = TAL.getSourceDeclExpression())
1250 return Visit(MakeCXCursor(E, StmtParent, TU));
1251 return false;
1252
1253 case TemplateArgument::Expression:
1254 if (Expr *E = TAL.getSourceExpression())
1255 return Visit(MakeCXCursor(E, StmtParent, TU));
1256 return false;
1257
1258 case TemplateArgument::Template:
Douglas Gregor0b36e612010-08-31 20:37:03 +00001259 return VisitTemplateName(TAL.getArgument().getAsTemplate(),
1260 TAL.getTemplateNameLoc());
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001261 }
1262
1263 return false;
1264}
1265
Ted Kremeneka0536d82010-05-07 01:04:29 +00001266bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
1267 return VisitDeclContext(D);
1268}
1269
Douglas Gregor01829d32010-08-31 14:41:23 +00001270bool CursorVisitor::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
1271 return Visit(TL.getUnqualifiedLoc());
1272}
1273
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001274bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Ted Kremeneka60ed472010-11-16 08:15:36 +00001275 ASTContext &Context = AU->getASTContext();
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001276
1277 // Some builtin types (such as Objective-C's "id", "sel", and
1278 // "Class") have associated declarations. Create cursors for those.
1279 QualType VisitType;
1280 switch (TL.getType()->getAs<BuiltinType>()->getKind()) {
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001281 case BuiltinType::Void:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001282 case BuiltinType::Bool:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001283 case BuiltinType::Char_U:
1284 case BuiltinType::UChar:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001285 case BuiltinType::Char16:
1286 case BuiltinType::Char32:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001287 case BuiltinType::UShort:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001288 case BuiltinType::UInt:
1289 case BuiltinType::ULong:
1290 case BuiltinType::ULongLong:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001291 case BuiltinType::UInt128:
1292 case BuiltinType::Char_S:
1293 case BuiltinType::SChar:
Chris Lattner3f59c972010-12-25 23:25:43 +00001294 case BuiltinType::WChar_U:
1295 case BuiltinType::WChar_S:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001296 case BuiltinType::Short:
1297 case BuiltinType::Int:
1298 case BuiltinType::Long:
1299 case BuiltinType::LongLong:
1300 case BuiltinType::Int128:
1301 case BuiltinType::Float:
1302 case BuiltinType::Double:
1303 case BuiltinType::LongDouble:
1304 case BuiltinType::NullPtr:
1305 case BuiltinType::Overload:
1306 case BuiltinType::Dependent:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001307 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001308
1309 case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor?
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001310 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001311
Ted Kremenekc4174cc2010-02-18 18:52:18 +00001312 case BuiltinType::ObjCId:
1313 VisitType = Context.getObjCIdType();
1314 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001315
1316 case BuiltinType::ObjCClass:
1317 VisitType = Context.getObjCClassType();
1318 break;
1319
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001320 case BuiltinType::ObjCSel:
1321 VisitType = Context.getObjCSelType();
1322 break;
1323 }
1324
1325 if (!VisitType.isNull()) {
1326 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001327 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001328 TU));
1329 }
1330
1331 return false;
1332}
1333
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001334bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
1335 return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU));
1336}
1337
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001338bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
1339 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1340}
1341
1342bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
1343 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1344}
1345
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001346bool CursorVisitor::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00001347 // FIXME: We can't visit the template type parameter, because there's
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001348 // no context information with which we can match up the depth/index in the
1349 // type to the appropriate
1350 return false;
1351}
1352
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001353bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
1354 if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU)))
1355 return true;
1356
John McCallc12c5bb2010-05-15 11:32:37 +00001357 return false;
1358}
1359
1360bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
1361 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
1362 return true;
1363
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001364 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1365 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1366 TU)))
1367 return true;
1368 }
1369
1370 return false;
1371}
1372
1373bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
John McCallc12c5bb2010-05-15 11:32:37 +00001374 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001375}
1376
Abramo Bagnara075f8f12010-12-10 16:29:40 +00001377bool CursorVisitor::VisitParenTypeLoc(ParenTypeLoc TL) {
1378 return Visit(TL.getInnerLoc());
1379}
1380
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001381bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
1382 return Visit(TL.getPointeeLoc());
1383}
1384
1385bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
1386 return Visit(TL.getPointeeLoc());
1387}
1388
1389bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
1390 return Visit(TL.getPointeeLoc());
1391}
1392
1393bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001394 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001395}
1396
1397bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001398 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001399}
1400
Douglas Gregor01829d32010-08-31 14:41:23 +00001401bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL,
1402 bool SkipResultType) {
1403 if (!SkipResultType && Visit(TL.getResultLoc()))
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001404 return true;
1405
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001406 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
Ted Kremenek5dbacb42010-04-07 00:27:13 +00001407 if (Decl *D = TL.getArg(I))
1408 if (Visit(MakeCXCursor(D, TU)))
1409 return true;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001410
1411 return false;
1412}
1413
1414bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
1415 if (Visit(TL.getElementLoc()))
1416 return true;
1417
1418 if (Expr *Size = TL.getSizeExpr())
1419 return Visit(MakeCXCursor(Size, StmtParent, TU));
1420
1421 return false;
1422}
1423
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001424bool CursorVisitor::VisitTemplateSpecializationTypeLoc(
1425 TemplateSpecializationTypeLoc TL) {
Douglas Gregor0b36e612010-08-31 20:37:03 +00001426 // Visit the template name.
1427 if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1428 TL.getTemplateNameLoc()))
1429 return true;
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001430
1431 // Visit the template arguments.
1432 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1433 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1434 return true;
1435
1436 return false;
1437}
1438
Douglas Gregor2332c112010-01-21 20:48:56 +00001439bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
1440 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
1441}
1442
1443bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
1444 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1445 return Visit(TSInfo->getTypeLoc());
1446
1447 return false;
1448}
1449
Douglas Gregor7536dd52010-12-20 02:24:11 +00001450bool CursorVisitor::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
1451 return Visit(TL.getPatternLoc());
1452}
1453
Ted Kremenek3064ef92010-08-27 21:34:58 +00001454bool CursorVisitor::VisitCXXRecordDecl(CXXRecordDecl *D) {
1455 if (D->isDefinition()) {
1456 for (CXXRecordDecl::base_class_iterator I = D->bases_begin(),
1457 E = D->bases_end(); I != E; ++I) {
1458 if (Visit(cxcursor::MakeCursorCXXBaseSpecifier(I, TU)))
1459 return true;
1460 }
1461 }
1462
1463 return VisitTagDecl(D);
1464}
1465
Ted Kremenek09dfa372010-02-18 05:46:33 +00001466bool CursorVisitor::VisitAttributes(Decl *D) {
Sean Huntcf807c42010-08-18 23:23:40 +00001467 for (AttrVec::const_iterator i = D->attr_begin(), e = D->attr_end();
1468 i != e; ++i)
1469 if (Visit(MakeCXCursor(*i, D, TU)))
Ted Kremenek09dfa372010-02-18 05:46:33 +00001470 return true;
1471
1472 return false;
1473}
1474
Ted Kremenekc0e1d922010-11-11 08:05:18 +00001475//===----------------------------------------------------------------------===//
1476// Data-recursive visitor methods.
1477//===----------------------------------------------------------------------===//
1478
Ted Kremenek28a71942010-11-13 00:36:47 +00001479namespace {
Ted Kremenek035dc412010-11-13 00:36:50 +00001480#define DEF_JOB(NAME, DATA, KIND)\
1481class NAME : public VisitorJob {\
1482public:\
1483 NAME(DATA *d, CXCursor parent) : VisitorJob(parent, VisitorJob::KIND, d) {} \
1484 static bool classof(const VisitorJob *VJ) { return VJ->getKind() == KIND; }\
Ted Kremenekf64d8032010-11-18 00:02:32 +00001485 DATA *get() const { return static_cast<DATA*>(data[0]); }\
Ted Kremenek035dc412010-11-13 00:36:50 +00001486};
1487
1488DEF_JOB(StmtVisit, Stmt, StmtVisitKind)
1489DEF_JOB(MemberExprParts, MemberExpr, MemberExprPartsKind)
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001490DEF_JOB(DeclRefExprParts, DeclRefExpr, DeclRefExprPartsKind)
Ted Kremenek035dc412010-11-13 00:36:50 +00001491DEF_JOB(OverloadExprParts, OverloadExpr, OverloadExprPartsKind)
Ted Kremenek60608ec2010-11-17 00:50:47 +00001492DEF_JOB(ExplicitTemplateArgsVisit, ExplicitTemplateArgumentList,
1493 ExplicitTemplateArgsVisitKind)
Ted Kremenek035dc412010-11-13 00:36:50 +00001494#undef DEF_JOB
1495
1496class DeclVisit : public VisitorJob {
1497public:
1498 DeclVisit(Decl *d, CXCursor parent, bool isFirst) :
1499 VisitorJob(parent, VisitorJob::DeclVisitKind,
1500 d, isFirst ? (void*) 1 : (void*) 0) {}
1501 static bool classof(const VisitorJob *VJ) {
Ted Kremenek82f3c502010-11-15 22:23:26 +00001502 return VJ->getKind() == DeclVisitKind;
Ted Kremenek035dc412010-11-13 00:36:50 +00001503 }
Ted Kremenekf64d8032010-11-18 00:02:32 +00001504 Decl *get() const { return static_cast<Decl*>(data[0]); }
1505 bool isFirst() const { return data[1] ? true : false; }
Ted Kremenek035dc412010-11-13 00:36:50 +00001506};
Ted Kremenek035dc412010-11-13 00:36:50 +00001507class TypeLocVisit : public VisitorJob {
1508public:
1509 TypeLocVisit(TypeLoc tl, CXCursor parent) :
1510 VisitorJob(parent, VisitorJob::TypeLocVisitKind,
1511 tl.getType().getAsOpaquePtr(), tl.getOpaqueData()) {}
1512
1513 static bool classof(const VisitorJob *VJ) {
1514 return VJ->getKind() == TypeLocVisitKind;
1515 }
1516
Ted Kremenek82f3c502010-11-15 22:23:26 +00001517 TypeLoc get() const {
Ted Kremenekf64d8032010-11-18 00:02:32 +00001518 QualType T = QualType::getFromOpaquePtr(data[0]);
1519 return TypeLoc(T, data[1]);
Ted Kremenek035dc412010-11-13 00:36:50 +00001520 }
1521};
1522
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001523class LabelRefVisit : public VisitorJob {
1524public:
1525 LabelRefVisit(LabelStmt *LS, SourceLocation labelLoc, CXCursor parent)
1526 : VisitorJob(parent, VisitorJob::LabelRefVisitKind, LS,
1527 (void*) labelLoc.getRawEncoding()) {}
1528
1529 static bool classof(const VisitorJob *VJ) {
1530 return VJ->getKind() == VisitorJob::LabelRefVisitKind;
1531 }
Ted Kremenekf64d8032010-11-18 00:02:32 +00001532 LabelStmt *get() const { return static_cast<LabelStmt*>(data[0]); }
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001533 SourceLocation getLoc() const {
Ted Kremenekf64d8032010-11-18 00:02:32 +00001534 return SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]); }
1535};
1536class NestedNameSpecifierVisit : public VisitorJob {
1537public:
1538 NestedNameSpecifierVisit(NestedNameSpecifier *NS, SourceRange R,
1539 CXCursor parent)
1540 : VisitorJob(parent, VisitorJob::NestedNameSpecifierVisitKind,
1541 NS, (void*) R.getBegin().getRawEncoding(),
1542 (void*) R.getEnd().getRawEncoding()) {}
1543 static bool classof(const VisitorJob *VJ) {
1544 return VJ->getKind() == VisitorJob::NestedNameSpecifierVisitKind;
1545 }
1546 NestedNameSpecifier *get() const {
1547 return static_cast<NestedNameSpecifier*>(data[0]);
1548 }
1549 SourceRange getSourceRange() const {
1550 SourceLocation A =
1551 SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]);
1552 SourceLocation B =
1553 SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[2]);
1554 return SourceRange(A, B);
1555 }
1556};
1557class DeclarationNameInfoVisit : public VisitorJob {
1558public:
1559 DeclarationNameInfoVisit(Stmt *S, CXCursor parent)
1560 : VisitorJob(parent, VisitorJob::DeclarationNameInfoVisitKind, S) {}
1561 static bool classof(const VisitorJob *VJ) {
1562 return VJ->getKind() == VisitorJob::DeclarationNameInfoVisitKind;
1563 }
1564 DeclarationNameInfo get() const {
1565 Stmt *S = static_cast<Stmt*>(data[0]);
1566 switch (S->getStmtClass()) {
1567 default:
1568 llvm_unreachable("Unhandled Stmt");
1569 case Stmt::CXXDependentScopeMemberExprClass:
1570 return cast<CXXDependentScopeMemberExpr>(S)->getMemberNameInfo();
1571 case Stmt::DependentScopeDeclRefExprClass:
1572 return cast<DependentScopeDeclRefExpr>(S)->getNameInfo();
1573 }
1574 }
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001575};
Ted Kremenekcdba6592010-11-18 00:42:18 +00001576class MemberRefVisit : public VisitorJob {
1577public:
1578 MemberRefVisit(FieldDecl *D, SourceLocation L, CXCursor parent)
1579 : VisitorJob(parent, VisitorJob::MemberRefVisitKind, D,
1580 (void*) L.getRawEncoding()) {}
1581 static bool classof(const VisitorJob *VJ) {
1582 return VJ->getKind() == VisitorJob::MemberRefVisitKind;
1583 }
1584 FieldDecl *get() const {
1585 return static_cast<FieldDecl*>(data[0]);
1586 }
1587 SourceLocation getLoc() const {
1588 return SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]);
1589 }
1590};
Ted Kremenek28a71942010-11-13 00:36:47 +00001591class EnqueueVisitor : public StmtVisitor<EnqueueVisitor, void> {
1592 VisitorWorkList &WL;
1593 CXCursor Parent;
1594public:
1595 EnqueueVisitor(VisitorWorkList &wl, CXCursor parent)
1596 : WL(wl), Parent(parent) {}
1597
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001598 void VisitAddrLabelExpr(AddrLabelExpr *E);
Ted Kremenek73d15c42010-11-13 01:09:29 +00001599 void VisitBlockExpr(BlockExpr *B);
Ted Kremenek28a71942010-11-13 00:36:47 +00001600 void VisitCompoundLiteralExpr(CompoundLiteralExpr *E);
Ted Kremenek083c7e22010-11-13 05:38:03 +00001601 void VisitCompoundStmt(CompoundStmt *S);
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001602 void VisitCXXDefaultArgExpr(CXXDefaultArgExpr *E) { /* Do nothing. */ }
Ted Kremenekf64d8032010-11-18 00:02:32 +00001603 void VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E);
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001604 void VisitCXXNewExpr(CXXNewExpr *E);
Ted Kremenek6d0a00d2010-11-17 02:18:35 +00001605 void VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001606 void VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001607 void VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E);
Ted Kremenek73d15c42010-11-13 01:09:29 +00001608 void VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E);
Ted Kremenekb8dd1ca2010-11-17 00:50:41 +00001609 void VisitCXXTypeidExpr(CXXTypeidExpr *E);
Ted Kremenek55b933a2010-11-17 00:50:36 +00001610 void VisitCXXUnresolvedConstructExpr(CXXUnresolvedConstructExpr *E);
Ted Kremenek1e7e8772010-11-17 00:50:52 +00001611 void VisitCXXUuidofExpr(CXXUuidofExpr *E);
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001612 void VisitDeclRefExpr(DeclRefExpr *D);
Ted Kremenek035dc412010-11-13 00:36:50 +00001613 void VisitDeclStmt(DeclStmt *S);
Ted Kremenekf64d8032010-11-18 00:02:32 +00001614 void VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001615 void VisitDesignatedInitExpr(DesignatedInitExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001616 void VisitExplicitCastExpr(ExplicitCastExpr *E);
1617 void VisitForStmt(ForStmt *FS);
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001618 void VisitGotoStmt(GotoStmt *GS);
Ted Kremenek28a71942010-11-13 00:36:47 +00001619 void VisitIfStmt(IfStmt *If);
1620 void VisitInitListExpr(InitListExpr *IE);
1621 void VisitMemberExpr(MemberExpr *M);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001622 void VisitOffsetOfExpr(OffsetOfExpr *E);
Ted Kremenek73d15c42010-11-13 01:09:29 +00001623 void VisitObjCEncodeExpr(ObjCEncodeExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001624 void VisitObjCMessageExpr(ObjCMessageExpr *M);
1625 void VisitOverloadExpr(OverloadExpr *E);
Ted Kremenek6d0a00d2010-11-17 02:18:35 +00001626 void VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001627 void VisitStmt(Stmt *S);
1628 void VisitSwitchStmt(SwitchStmt *S);
1629 void VisitWhileStmt(WhileStmt *W);
Ted Kremenek2939b6f2010-11-17 00:50:50 +00001630 void VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E);
Francois Pichet6ad6f282010-12-07 00:08:36 +00001631 void VisitBinaryTypeTraitExpr(BinaryTypeTraitExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001632 void VisitUnresolvedMemberExpr(UnresolvedMemberExpr *U);
Ted Kremenek9d3bf792010-11-17 00:50:43 +00001633 void VisitVAArgExpr(VAArgExpr *E);
Douglas Gregoree8aff02011-01-04 17:33:58 +00001634 // FIXME: Variadic templates SizeOfPackExpr!
1635
Ted Kremenek28a71942010-11-13 00:36:47 +00001636private:
Ted Kremenekf64d8032010-11-18 00:02:32 +00001637 void AddDeclarationNameInfo(Stmt *S);
1638 void AddNestedNameSpecifier(NestedNameSpecifier *NS, SourceRange R);
Ted Kremenek60608ec2010-11-17 00:50:47 +00001639 void AddExplicitTemplateArgs(const ExplicitTemplateArgumentList *A);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001640 void AddMemberRef(FieldDecl *D, SourceLocation L);
Ted Kremenek28a71942010-11-13 00:36:47 +00001641 void AddStmt(Stmt *S);
Ted Kremenek035dc412010-11-13 00:36:50 +00001642 void AddDecl(Decl *D, bool isFirst = true);
Ted Kremenek28a71942010-11-13 00:36:47 +00001643 void AddTypeLoc(TypeSourceInfo *TI);
1644 void EnqueueChildren(Stmt *S);
1645};
1646} // end anonyous namespace
1647
Ted Kremenekf64d8032010-11-18 00:02:32 +00001648void EnqueueVisitor::AddDeclarationNameInfo(Stmt *S) {
1649 // 'S' should always be non-null, since it comes from the
1650 // statement we are visiting.
1651 WL.push_back(DeclarationNameInfoVisit(S, Parent));
1652}
1653void EnqueueVisitor::AddNestedNameSpecifier(NestedNameSpecifier *N,
1654 SourceRange R) {
1655 if (N)
1656 WL.push_back(NestedNameSpecifierVisit(N, R, Parent));
1657}
Ted Kremenek28a71942010-11-13 00:36:47 +00001658void EnqueueVisitor::AddStmt(Stmt *S) {
1659 if (S)
1660 WL.push_back(StmtVisit(S, Parent));
1661}
Ted Kremenek035dc412010-11-13 00:36:50 +00001662void EnqueueVisitor::AddDecl(Decl *D, bool isFirst) {
Ted Kremenek28a71942010-11-13 00:36:47 +00001663 if (D)
Ted Kremenek035dc412010-11-13 00:36:50 +00001664 WL.push_back(DeclVisit(D, Parent, isFirst));
Ted Kremenek28a71942010-11-13 00:36:47 +00001665}
Ted Kremenek60608ec2010-11-17 00:50:47 +00001666void EnqueueVisitor::
1667 AddExplicitTemplateArgs(const ExplicitTemplateArgumentList *A) {
1668 if (A)
1669 WL.push_back(ExplicitTemplateArgsVisit(
1670 const_cast<ExplicitTemplateArgumentList*>(A), Parent));
1671}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001672void EnqueueVisitor::AddMemberRef(FieldDecl *D, SourceLocation L) {
1673 if (D)
1674 WL.push_back(MemberRefVisit(D, L, Parent));
1675}
Ted Kremenek28a71942010-11-13 00:36:47 +00001676void EnqueueVisitor::AddTypeLoc(TypeSourceInfo *TI) {
1677 if (TI)
1678 WL.push_back(TypeLocVisit(TI->getTypeLoc(), Parent));
1679 }
1680void EnqueueVisitor::EnqueueChildren(Stmt *S) {
Ted Kremeneka6b70432010-11-12 21:34:09 +00001681 unsigned size = WL.size();
1682 for (Stmt::child_iterator Child = S->child_begin(), ChildEnd = S->child_end();
1683 Child != ChildEnd; ++Child) {
Ted Kremenek28a71942010-11-13 00:36:47 +00001684 AddStmt(*Child);
Ted Kremeneka6b70432010-11-12 21:34:09 +00001685 }
1686 if (size == WL.size())
1687 return;
1688 // Now reverse the entries we just added. This will match the DFS
1689 // ordering performed by the worklist.
1690 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
1691 std::reverse(I, E);
1692}
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001693void EnqueueVisitor::VisitAddrLabelExpr(AddrLabelExpr *E) {
1694 WL.push_back(LabelRefVisit(E->getLabel(), E->getLabelLoc(), Parent));
1695}
Ted Kremenek73d15c42010-11-13 01:09:29 +00001696void EnqueueVisitor::VisitBlockExpr(BlockExpr *B) {
1697 AddDecl(B->getBlockDecl());
1698}
Ted Kremenek28a71942010-11-13 00:36:47 +00001699void EnqueueVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) {
1700 EnqueueChildren(E);
1701 AddTypeLoc(E->getTypeSourceInfo());
1702}
Ted Kremenek083c7e22010-11-13 05:38:03 +00001703void EnqueueVisitor::VisitCompoundStmt(CompoundStmt *S) {
1704 for (CompoundStmt::reverse_body_iterator I = S->body_rbegin(),
1705 E = S->body_rend(); I != E; ++I) {
1706 AddStmt(*I);
1707 }
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001708}
Ted Kremenekf64d8032010-11-18 00:02:32 +00001709void EnqueueVisitor::
1710VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E) {
1711 AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
1712 AddDeclarationNameInfo(E);
1713 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1714 AddNestedNameSpecifier(Qualifier, E->getQualifierRange());
1715 if (!E->isImplicitAccess())
1716 AddStmt(E->getBase());
1717}
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001718void EnqueueVisitor::VisitCXXNewExpr(CXXNewExpr *E) {
1719 // Enqueue the initializer or constructor arguments.
1720 for (unsigned I = E->getNumConstructorArgs(); I > 0; --I)
1721 AddStmt(E->getConstructorArg(I-1));
1722 // Enqueue the array size, if any.
1723 AddStmt(E->getArraySize());
1724 // Enqueue the allocated type.
1725 AddTypeLoc(E->getAllocatedTypeSourceInfo());
1726 // Enqueue the placement arguments.
1727 for (unsigned I = E->getNumPlacementArgs(); I > 0; --I)
1728 AddStmt(E->getPlacementArg(I-1));
1729}
Ted Kremenek28a71942010-11-13 00:36:47 +00001730void EnqueueVisitor::VisitCXXOperatorCallExpr(CXXOperatorCallExpr *CE) {
Ted Kremenek8b8d8c92010-11-13 05:55:56 +00001731 for (unsigned I = CE->getNumArgs(); I > 1 /* Yes, this is 1 */; --I)
1732 AddStmt(CE->getArg(I-1));
Ted Kremenek28a71942010-11-13 00:36:47 +00001733 AddStmt(CE->getCallee());
1734 AddStmt(CE->getArg(0));
1735}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001736void EnqueueVisitor::VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E) {
1737 // Visit the name of the type being destroyed.
1738 AddTypeLoc(E->getDestroyedTypeInfo());
1739 // Visit the scope type that looks disturbingly like the nested-name-specifier
1740 // but isn't.
1741 AddTypeLoc(E->getScopeTypeInfo());
1742 // Visit the nested-name-specifier.
1743 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1744 AddNestedNameSpecifier(Qualifier, E->getQualifierRange());
1745 // Visit base expression.
1746 AddStmt(E->getBase());
1747}
Ted Kremenek6d0a00d2010-11-17 02:18:35 +00001748void EnqueueVisitor::VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E) {
1749 AddTypeLoc(E->getTypeSourceInfo());
1750}
Ted Kremenek73d15c42010-11-13 01:09:29 +00001751void EnqueueVisitor::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E) {
1752 EnqueueChildren(E);
1753 AddTypeLoc(E->getTypeSourceInfo());
1754}
Ted Kremenekb8dd1ca2010-11-17 00:50:41 +00001755void EnqueueVisitor::VisitCXXTypeidExpr(CXXTypeidExpr *E) {
1756 EnqueueChildren(E);
1757 if (E->isTypeOperand())
1758 AddTypeLoc(E->getTypeOperandSourceInfo());
1759}
Ted Kremenek55b933a2010-11-17 00:50:36 +00001760
1761void EnqueueVisitor::VisitCXXUnresolvedConstructExpr(CXXUnresolvedConstructExpr
1762 *E) {
1763 EnqueueChildren(E);
1764 AddTypeLoc(E->getTypeSourceInfo());
1765}
Ted Kremenek1e7e8772010-11-17 00:50:52 +00001766void EnqueueVisitor::VisitCXXUuidofExpr(CXXUuidofExpr *E) {
1767 EnqueueChildren(E);
1768 if (E->isTypeOperand())
1769 AddTypeLoc(E->getTypeOperandSourceInfo());
1770}
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001771void EnqueueVisitor::VisitDeclRefExpr(DeclRefExpr *DR) {
Ted Kremenek60608ec2010-11-17 00:50:47 +00001772 if (DR->hasExplicitTemplateArgs()) {
1773 AddExplicitTemplateArgs(&DR->getExplicitTemplateArgs());
1774 }
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001775 WL.push_back(DeclRefExprParts(DR, Parent));
1776}
Ted Kremenekf64d8032010-11-18 00:02:32 +00001777void EnqueueVisitor::VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E) {
1778 AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
1779 AddDeclarationNameInfo(E);
1780 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1781 AddNestedNameSpecifier(Qualifier, E->getQualifierRange());
1782}
Ted Kremenek035dc412010-11-13 00:36:50 +00001783void EnqueueVisitor::VisitDeclStmt(DeclStmt *S) {
1784 unsigned size = WL.size();
1785 bool isFirst = true;
1786 for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end();
1787 D != DEnd; ++D) {
1788 AddDecl(*D, isFirst);
1789 isFirst = false;
1790 }
1791 if (size == WL.size())
1792 return;
1793 // Now reverse the entries we just added. This will match the DFS
1794 // ordering performed by the worklist.
1795 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
1796 std::reverse(I, E);
1797}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001798void EnqueueVisitor::VisitDesignatedInitExpr(DesignatedInitExpr *E) {
1799 AddStmt(E->getInit());
1800 typedef DesignatedInitExpr::Designator Designator;
1801 for (DesignatedInitExpr::reverse_designators_iterator
1802 D = E->designators_rbegin(), DEnd = E->designators_rend();
1803 D != DEnd; ++D) {
1804 if (D->isFieldDesignator()) {
1805 if (FieldDecl *Field = D->getField())
1806 AddMemberRef(Field, D->getFieldLoc());
1807 continue;
1808 }
1809 if (D->isArrayDesignator()) {
1810 AddStmt(E->getArrayIndex(*D));
1811 continue;
1812 }
1813 assert(D->isArrayRangeDesignator() && "Unknown designator kind");
1814 AddStmt(E->getArrayRangeEnd(*D));
1815 AddStmt(E->getArrayRangeStart(*D));
1816 }
1817}
Ted Kremenek28a71942010-11-13 00:36:47 +00001818void EnqueueVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) {
1819 EnqueueChildren(E);
1820 AddTypeLoc(E->getTypeInfoAsWritten());
1821}
1822void EnqueueVisitor::VisitForStmt(ForStmt *FS) {
1823 AddStmt(FS->getBody());
1824 AddStmt(FS->getInc());
1825 AddStmt(FS->getCond());
1826 AddDecl(FS->getConditionVariable());
1827 AddStmt(FS->getInit());
1828}
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001829void EnqueueVisitor::VisitGotoStmt(GotoStmt *GS) {
1830 WL.push_back(LabelRefVisit(GS->getLabel(), GS->getLabelLoc(), Parent));
1831}
Ted Kremenek28a71942010-11-13 00:36:47 +00001832void EnqueueVisitor::VisitIfStmt(IfStmt *If) {
1833 AddStmt(If->getElse());
1834 AddStmt(If->getThen());
1835 AddStmt(If->getCond());
1836 AddDecl(If->getConditionVariable());
1837}
1838void EnqueueVisitor::VisitInitListExpr(InitListExpr *IE) {
1839 // We care about the syntactic form of the initializer list, only.
1840 if (InitListExpr *Syntactic = IE->getSyntacticForm())
1841 IE = Syntactic;
1842 EnqueueChildren(IE);
1843}
1844void EnqueueVisitor::VisitMemberExpr(MemberExpr *M) {
Douglas Gregor89629a72010-11-17 17:15:08 +00001845 WL.push_back(MemberExprParts(M, Parent));
1846
1847 // If the base of the member access expression is an implicit 'this', don't
1848 // visit it.
1849 // FIXME: If we ever want to show these implicit accesses, this will be
1850 // unfortunate. However, clang_getCursor() relies on this behavior.
1851 if (CXXThisExpr *This
1852 = llvm::dyn_cast<CXXThisExpr>(M->getBase()->IgnoreParenImpCasts()))
1853 if (This->isImplicit())
1854 return;
1855
Ted Kremenek28a71942010-11-13 00:36:47 +00001856 AddStmt(M->getBase());
1857}
Ted Kremenek73d15c42010-11-13 01:09:29 +00001858void EnqueueVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) {
1859 AddTypeLoc(E->getEncodedTypeSourceInfo());
1860}
Ted Kremenek28a71942010-11-13 00:36:47 +00001861void EnqueueVisitor::VisitObjCMessageExpr(ObjCMessageExpr *M) {
1862 EnqueueChildren(M);
1863 AddTypeLoc(M->getClassReceiverTypeInfo());
1864}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001865void EnqueueVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) {
1866 // Visit the components of the offsetof expression.
1867 for (unsigned N = E->getNumComponents(), I = N; I > 0; --I) {
1868 typedef OffsetOfExpr::OffsetOfNode OffsetOfNode;
1869 const OffsetOfNode &Node = E->getComponent(I-1);
1870 switch (Node.getKind()) {
1871 case OffsetOfNode::Array:
1872 AddStmt(E->getIndexExpr(Node.getArrayExprIndex()));
1873 break;
1874 case OffsetOfNode::Field:
1875 AddMemberRef(Node.getField(), Node.getRange().getEnd());
1876 break;
1877 case OffsetOfNode::Identifier:
1878 case OffsetOfNode::Base:
1879 continue;
1880 }
1881 }
1882 // Visit the type into which we're computing the offset.
1883 AddTypeLoc(E->getTypeSourceInfo());
1884}
Ted Kremenek28a71942010-11-13 00:36:47 +00001885void EnqueueVisitor::VisitOverloadExpr(OverloadExpr *E) {
Ted Kremenek60608ec2010-11-17 00:50:47 +00001886 AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
Ted Kremenek60458782010-11-12 21:34:16 +00001887 WL.push_back(OverloadExprParts(E, Parent));
1888}
Ted Kremenek6d0a00d2010-11-17 02:18:35 +00001889void EnqueueVisitor::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E) {
1890 EnqueueChildren(E);
1891 if (E->isArgumentType())
1892 AddTypeLoc(E->getArgumentTypeInfo());
1893}
Ted Kremenek28a71942010-11-13 00:36:47 +00001894void EnqueueVisitor::VisitStmt(Stmt *S) {
1895 EnqueueChildren(S);
1896}
1897void EnqueueVisitor::VisitSwitchStmt(SwitchStmt *S) {
1898 AddStmt(S->getBody());
1899 AddStmt(S->getCond());
1900 AddDecl(S->getConditionVariable());
1901}
Ted Kremenekfafa75a2010-11-17 00:50:39 +00001902
Ted Kremenek28a71942010-11-13 00:36:47 +00001903void EnqueueVisitor::VisitWhileStmt(WhileStmt *W) {
1904 AddStmt(W->getBody());
1905 AddStmt(W->getCond());
1906 AddDecl(W->getConditionVariable());
1907}
Ted Kremenek2939b6f2010-11-17 00:50:50 +00001908void EnqueueVisitor::VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E) {
1909 AddTypeLoc(E->getQueriedTypeSourceInfo());
1910}
Francois Pichet6ad6f282010-12-07 00:08:36 +00001911
1912void EnqueueVisitor::VisitBinaryTypeTraitExpr(BinaryTypeTraitExpr *E) {
Francois Pichet6ad6f282010-12-07 00:08:36 +00001913 AddTypeLoc(E->getRhsTypeSourceInfo());
Francois Pichet0a03a3f2010-12-08 09:11:05 +00001914 AddTypeLoc(E->getLhsTypeSourceInfo());
Francois Pichet6ad6f282010-12-07 00:08:36 +00001915}
1916
Ted Kremenek28a71942010-11-13 00:36:47 +00001917void EnqueueVisitor::VisitUnresolvedMemberExpr(UnresolvedMemberExpr *U) {
1918 VisitOverloadExpr(U);
1919 if (!U->isImplicitAccess())
1920 AddStmt(U->getBase());
1921}
Ted Kremenek9d3bf792010-11-17 00:50:43 +00001922void EnqueueVisitor::VisitVAArgExpr(VAArgExpr *E) {
1923 AddStmt(E->getSubExpr());
1924 AddTypeLoc(E->getWrittenTypeInfo());
1925}
Ted Kremenek60458782010-11-12 21:34:16 +00001926
Ted Kremenekc0e1d922010-11-11 08:05:18 +00001927void CursorVisitor::EnqueueWorkList(VisitorWorkList &WL, Stmt *S) {
Ted Kremenek28a71942010-11-13 00:36:47 +00001928 EnqueueVisitor(WL, MakeCXCursor(S, StmtParent, TU)).Visit(S);
Ted Kremenekc0e1d922010-11-11 08:05:18 +00001929}
1930
1931bool CursorVisitor::IsInRegionOfInterest(CXCursor C) {
1932 if (RegionOfInterest.isValid()) {
1933 SourceRange Range = getRawCursorExtent(C);
1934 if (Range.isInvalid() || CompareRegionOfInterest(Range))
1935 return false;
1936 }
1937 return true;
1938}
1939
1940bool CursorVisitor::RunVisitorWorkList(VisitorWorkList &WL) {
1941 while (!WL.empty()) {
1942 // Dequeue the worklist item.
Ted Kremenek82f3c502010-11-15 22:23:26 +00001943 VisitorJob LI = WL.back();
1944 WL.pop_back();
1945
Ted Kremenekc0e1d922010-11-11 08:05:18 +00001946 // Set the Parent field, then back to its old value once we're done.
1947 SetParentRAII SetParent(Parent, StmtParent, LI.getParent());
1948
1949 switch (LI.getKind()) {
Ted Kremenekf1107452010-11-12 18:26:56 +00001950 case VisitorJob::DeclVisitKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00001951 Decl *D = cast<DeclVisit>(&LI)->get();
Ted Kremenekf1107452010-11-12 18:26:56 +00001952 if (!D)
1953 continue;
1954
1955 // For now, perform default visitation for Decls.
Ted Kremenek82f3c502010-11-15 22:23:26 +00001956 if (Visit(MakeCXCursor(D, TU, cast<DeclVisit>(&LI)->isFirst())))
Ted Kremenekf1107452010-11-12 18:26:56 +00001957 return true;
1958
1959 continue;
1960 }
Ted Kremenek60608ec2010-11-17 00:50:47 +00001961 case VisitorJob::ExplicitTemplateArgsVisitKind: {
1962 const ExplicitTemplateArgumentList *ArgList =
1963 cast<ExplicitTemplateArgsVisit>(&LI)->get();
1964 for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1965 *ArgEnd = Arg + ArgList->NumTemplateArgs;
1966 Arg != ArgEnd; ++Arg) {
1967 if (VisitTemplateArgumentLoc(*Arg))
1968 return true;
1969 }
1970 continue;
1971 }
Ted Kremenekcdb4caf2010-11-12 21:34:12 +00001972 case VisitorJob::TypeLocVisitKind: {
1973 // Perform default visitation for TypeLocs.
Ted Kremenek82f3c502010-11-15 22:23:26 +00001974 if (Visit(cast<TypeLocVisit>(&LI)->get()))
Ted Kremenekcdb4caf2010-11-12 21:34:12 +00001975 return true;
1976 continue;
1977 }
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001978 case VisitorJob::LabelRefVisitKind: {
1979 LabelStmt *LS = cast<LabelRefVisit>(&LI)->get();
1980 if (Visit(MakeCursorLabelRef(LS,
1981 cast<LabelRefVisit>(&LI)->getLoc(),
1982 TU)))
1983 return true;
1984 continue;
1985 }
Ted Kremenekf64d8032010-11-18 00:02:32 +00001986 case VisitorJob::NestedNameSpecifierVisitKind: {
1987 NestedNameSpecifierVisit *V = cast<NestedNameSpecifierVisit>(&LI);
1988 if (VisitNestedNameSpecifier(V->get(), V->getSourceRange()))
1989 return true;
1990 continue;
1991 }
1992 case VisitorJob::DeclarationNameInfoVisitKind: {
1993 if (VisitDeclarationNameInfo(cast<DeclarationNameInfoVisit>(&LI)
1994 ->get()))
1995 return true;
1996 continue;
1997 }
Ted Kremenekcdba6592010-11-18 00:42:18 +00001998 case VisitorJob::MemberRefVisitKind: {
1999 MemberRefVisit *V = cast<MemberRefVisit>(&LI);
2000 if (Visit(MakeCursorMemberRef(V->get(), V->getLoc(), TU)))
2001 return true;
2002 continue;
2003 }
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002004 case VisitorJob::StmtVisitKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00002005 Stmt *S = cast<StmtVisit>(&LI)->get();
Ted Kremenek8c269ac2010-11-11 23:11:43 +00002006 if (!S)
2007 continue;
2008
Ted Kremenekf1107452010-11-12 18:26:56 +00002009 // Update the current cursor.
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002010 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU);
Ted Kremenekcdba6592010-11-18 00:42:18 +00002011 if (!IsInRegionOfInterest(Cursor))
2012 continue;
2013 switch (Visitor(Cursor, Parent, ClientData)) {
2014 case CXChildVisit_Break: return true;
2015 case CXChildVisit_Continue: break;
2016 case CXChildVisit_Recurse:
2017 EnqueueWorkList(WL, S);
Ted Kremenek82f3c502010-11-15 22:23:26 +00002018 break;
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002019 }
Ted Kremenek82f3c502010-11-15 22:23:26 +00002020 continue;
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002021 }
2022 case VisitorJob::MemberExprPartsKind: {
2023 // Handle the other pieces in the MemberExpr besides the base.
Ted Kremenek82f3c502010-11-15 22:23:26 +00002024 MemberExpr *M = cast<MemberExprParts>(&LI)->get();
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002025
2026 // Visit the nested-name-specifier
2027 if (NestedNameSpecifier *Qualifier = M->getQualifier())
2028 if (VisitNestedNameSpecifier(Qualifier, M->getQualifierRange()))
2029 return true;
2030
2031 // Visit the declaration name.
2032 if (VisitDeclarationNameInfo(M->getMemberNameInfo()))
2033 return true;
2034
2035 // Visit the explicitly-specified template arguments, if any.
2036 if (M->hasExplicitTemplateArgs()) {
2037 for (const TemplateArgumentLoc *Arg = M->getTemplateArgs(),
2038 *ArgEnd = Arg + M->getNumTemplateArgs();
2039 Arg != ArgEnd; ++Arg) {
2040 if (VisitTemplateArgumentLoc(*Arg))
2041 return true;
2042 }
2043 }
2044 continue;
2045 }
Ted Kremeneke4979cc2010-11-13 00:58:18 +00002046 case VisitorJob::DeclRefExprPartsKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00002047 DeclRefExpr *DR = cast<DeclRefExprParts>(&LI)->get();
Ted Kremeneke4979cc2010-11-13 00:58:18 +00002048 // Visit nested-name-specifier, if present.
2049 if (NestedNameSpecifier *Qualifier = DR->getQualifier())
2050 if (VisitNestedNameSpecifier(Qualifier, DR->getQualifierRange()))
2051 return true;
2052 // Visit declaration name.
2053 if (VisitDeclarationNameInfo(DR->getNameInfo()))
2054 return true;
Ted Kremeneke4979cc2010-11-13 00:58:18 +00002055 continue;
2056 }
Ted Kremenek60458782010-11-12 21:34:16 +00002057 case VisitorJob::OverloadExprPartsKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00002058 OverloadExpr *O = cast<OverloadExprParts>(&LI)->get();
Ted Kremenek60458782010-11-12 21:34:16 +00002059 // Visit the nested-name-specifier.
2060 if (NestedNameSpecifier *Qualifier = O->getQualifier())
2061 if (VisitNestedNameSpecifier(Qualifier, O->getQualifierRange()))
2062 return true;
2063 // Visit the declaration name.
2064 if (VisitDeclarationNameInfo(O->getNameInfo()))
2065 return true;
2066 // Visit the overloaded declaration reference.
2067 if (Visit(MakeCursorOverloadedDeclRef(O, TU)))
2068 return true;
Ted Kremenek60458782010-11-12 21:34:16 +00002069 continue;
2070 }
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002071 }
2072 }
2073 return false;
2074}
2075
Ted Kremenekcdba6592010-11-18 00:42:18 +00002076bool CursorVisitor::Visit(Stmt *S) {
Ted Kremenekd1ded662010-11-15 23:31:32 +00002077 VisitorWorkList *WL = 0;
2078 if (!WorkListFreeList.empty()) {
2079 WL = WorkListFreeList.back();
2080 WL->clear();
2081 WorkListFreeList.pop_back();
2082 }
2083 else {
2084 WL = new VisitorWorkList();
2085 WorkListCache.push_back(WL);
2086 }
2087 EnqueueWorkList(*WL, S);
2088 bool result = RunVisitorWorkList(*WL);
2089 WorkListFreeList.push_back(WL);
2090 return result;
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002091}
2092
2093//===----------------------------------------------------------------------===//
2094// Misc. API hooks.
2095//===----------------------------------------------------------------------===//
2096
Douglas Gregor8c8d5412010-09-24 21:18:36 +00002097static llvm::sys::Mutex EnableMultithreadingMutex;
2098static bool EnabledMultithreading;
2099
Benjamin Kramer5e4bc592009-10-18 16:11:04 +00002100extern "C" {
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002101CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
2102 int displayDiagnostics) {
Daniel Dunbar48615ff2010-10-08 19:30:33 +00002103 // Disable pretty stack trace functionality, which will otherwise be a very
2104 // poor citizen of the world and set up all sorts of signal handlers.
2105 llvm::DisablePrettyStackTrace = true;
2106
Daniel Dunbarc7df4f32010-08-18 18:43:14 +00002107 // We use crash recovery to make some of our APIs more reliable, implicitly
2108 // enable it.
2109 llvm::CrashRecoveryContext::Enable();
2110
Douglas Gregor8c8d5412010-09-24 21:18:36 +00002111 // Enable support for multithreading in LLVM.
2112 {
2113 llvm::sys::ScopedLock L(EnableMultithreadingMutex);
2114 if (!EnabledMultithreading) {
2115 llvm::llvm_start_multithreaded();
2116 EnabledMultithreading = true;
2117 }
2118 }
2119
Douglas Gregora030b7c2010-01-22 20:35:53 +00002120 CIndexer *CIdxr = new CIndexer();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002121 if (excludeDeclarationsFromPCH)
2122 CIdxr->setOnlyLocalDecls();
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002123 if (displayDiagnostics)
2124 CIdxr->setDisplayDiagnostics();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002125 return CIdxr;
Steve Naroff600866c2009-08-27 19:51:58 +00002126}
2127
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002128void clang_disposeIndex(CXIndex CIdx) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002129 if (CIdx)
2130 delete static_cast<CIndexer *>(CIdx);
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00002131}
2132
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002133CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
Douglas Gregora88084b2010-02-18 18:08:43 +00002134 const char *ast_filename) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002135 if (!CIdx)
2136 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002137
Douglas Gregor7d1d49d2009-10-16 20:01:17 +00002138 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +00002139 FileSystemOptions FileSystemOpts;
2140 FileSystemOpts.WorkingDir = CXXIdx->getWorkingDirectory();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002141
Douglas Gregor28019772010-04-05 23:52:57 +00002142 llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
Ted Kremeneka60ed472010-11-16 08:15:36 +00002143 ASTUnit *TU = ASTUnit::LoadFromASTFile(ast_filename, Diags, FileSystemOpts,
Douglas Gregora88084b2010-02-18 18:08:43 +00002144 CXXIdx->getOnlyLocalDecls(),
2145 0, 0, true);
Ted Kremeneka60ed472010-11-16 08:15:36 +00002146 return MakeCXTranslationUnit(TU);
Steve Naroff600866c2009-08-27 19:51:58 +00002147}
2148
Douglas Gregorb1c031b2010-08-09 22:28:58 +00002149unsigned clang_defaultEditingTranslationUnitOptions() {
Douglas Gregor2a2c50b2010-09-27 05:49:58 +00002150 return CXTranslationUnit_PrecompiledPreamble |
Douglas Gregor99ba2022010-10-27 17:24:53 +00002151 CXTranslationUnit_CacheCompletionResults |
2152 CXTranslationUnit_CXXPrecompiledPreamble;
Douglas Gregorb1c031b2010-08-09 22:28:58 +00002153}
2154
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002155CXTranslationUnit
2156clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
2157 const char *source_filename,
2158 int num_command_line_args,
Douglas Gregor2ef69442010-09-01 16:43:19 +00002159 const char * const *command_line_args,
Douglas Gregor4db64a42010-01-23 00:14:00 +00002160 unsigned num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +00002161 struct CXUnsavedFile *unsaved_files) {
Douglas Gregor5a430212010-07-21 18:52:53 +00002162 return clang_parseTranslationUnit(CIdx, source_filename,
2163 command_line_args, num_command_line_args,
2164 unsaved_files, num_unsaved_files,
2165 CXTranslationUnit_DetailedPreprocessingRecord);
2166}
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002167
2168struct ParseTranslationUnitInfo {
2169 CXIndex CIdx;
2170 const char *source_filename;
Douglas Gregor2ef69442010-09-01 16:43:19 +00002171 const char *const *command_line_args;
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002172 int num_command_line_args;
2173 struct CXUnsavedFile *unsaved_files;
2174 unsigned num_unsaved_files;
2175 unsigned options;
2176 CXTranslationUnit result;
2177};
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00002178static void clang_parseTranslationUnit_Impl(void *UserData) {
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002179 ParseTranslationUnitInfo *PTUI =
2180 static_cast<ParseTranslationUnitInfo*>(UserData);
2181 CXIndex CIdx = PTUI->CIdx;
2182 const char *source_filename = PTUI->source_filename;
Douglas Gregor2ef69442010-09-01 16:43:19 +00002183 const char * const *command_line_args = PTUI->command_line_args;
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002184 int num_command_line_args = PTUI->num_command_line_args;
2185 struct CXUnsavedFile *unsaved_files = PTUI->unsaved_files;
2186 unsigned num_unsaved_files = PTUI->num_unsaved_files;
2187 unsigned options = PTUI->options;
2188 PTUI->result = 0;
Douglas Gregor5a430212010-07-21 18:52:53 +00002189
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002190 if (!CIdx)
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002191 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002192
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002193 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
2194
Douglas Gregor44c181a2010-07-23 00:33:23 +00002195 bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
Douglas Gregordf95a132010-08-09 20:45:32 +00002196 bool CompleteTranslationUnit
2197 = ((options & CXTranslationUnit_Incomplete) == 0);
Douglas Gregor87c08a52010-08-13 22:48:40 +00002198 bool CacheCodeCompetionResults
2199 = options & CXTranslationUnit_CacheCompletionResults;
Douglas Gregor99ba2022010-10-27 17:24:53 +00002200 bool CXXPrecompilePreamble
2201 = options & CXTranslationUnit_CXXPrecompiledPreamble;
2202 bool CXXChainedPCH
2203 = options & CXTranslationUnit_CXXChainedPCH;
Douglas Gregor87c08a52010-08-13 22:48:40 +00002204
Douglas Gregor5352ac02010-01-28 00:27:43 +00002205 // Configure the diagnostics.
2206 DiagnosticOptions DiagOpts;
Douglas Gregor28019772010-04-05 23:52:57 +00002207 llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
2208 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002209
Douglas Gregor4db64a42010-01-23 00:14:00 +00002210 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
2211 for (unsigned I = 0; I != num_unsaved_files; ++I) {
Chris Lattnera0a270c2010-04-05 22:42:27 +00002212 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002213 const llvm::MemoryBuffer *Buffer
Chris Lattnera0a270c2010-04-05 22:42:27 +00002214 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
Douglas Gregor4db64a42010-01-23 00:14:00 +00002215 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2216 Buffer));
2217 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002218
Douglas Gregorb10daed2010-10-11 16:52:23 +00002219 llvm::SmallVector<const char *, 16> Args;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002220
Ted Kremenek139ba862009-10-22 00:03:57 +00002221 // The 'source_filename' argument is optional. If the caller does not
2222 // specify it then it is assumed that the source file is specified
2223 // in the actual argument list.
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002224 if (source_filename)
Douglas Gregorb10daed2010-10-11 16:52:23 +00002225 Args.push_back(source_filename);
Douglas Gregor52ddc5d2010-07-09 18:39:07 +00002226
2227 // Since the Clang C library is primarily used by batch tools dealing with
2228 // (often very broken) source code, where spell-checking can have a
2229 // significant negative impact on performance (particularly when
2230 // precompiled headers are involved), we disable it by default.
Douglas Gregorb10daed2010-10-11 16:52:23 +00002231 // Only do this if we haven't found a spell-checking-related argument.
2232 bool FoundSpellCheckingArgument = false;
2233 for (int I = 0; I != num_command_line_args; ++I) {
2234 if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 ||
2235 strcmp(command_line_args[I], "-fspell-checking") == 0) {
2236 FoundSpellCheckingArgument = true;
2237 break;
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002238 }
Douglas Gregorb10daed2010-10-11 16:52:23 +00002239 }
2240 if (!FoundSpellCheckingArgument)
2241 Args.push_back("-fno-spell-checking");
2242
2243 Args.insert(Args.end(), command_line_args,
2244 command_line_args + num_command_line_args);
Douglas Gregord93256e2010-01-28 06:00:51 +00002245
Douglas Gregor44c181a2010-07-23 00:33:23 +00002246 // Do we need the detailed preprocessing record?
2247 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
Douglas Gregorb10daed2010-10-11 16:52:23 +00002248 Args.push_back("-Xclang");
2249 Args.push_back("-detailed-preprocessing-record");
Douglas Gregor44c181a2010-07-23 00:33:23 +00002250 }
2251
Argyrios Kyrtzidis026f6912010-11-18 21:47:04 +00002252 unsigned NumErrors = Diags->getClient()->getNumErrors();
Douglas Gregorb10daed2010-10-11 16:52:23 +00002253 llvm::OwningPtr<ASTUnit> Unit(
2254 ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(),
2255 Diags,
2256 CXXIdx->getClangResourcesPath(),
2257 CXXIdx->getOnlyLocalDecls(),
Douglas Gregore47be3e2010-11-11 00:39:14 +00002258 /*CaptureDiagnostics=*/true,
Douglas Gregorb10daed2010-10-11 16:52:23 +00002259 RemappedFiles.data(),
2260 RemappedFiles.size(),
Douglas Gregorb10daed2010-10-11 16:52:23 +00002261 PrecompilePreamble,
2262 CompleteTranslationUnit,
Douglas Gregor99ba2022010-10-27 17:24:53 +00002263 CacheCodeCompetionResults,
2264 CXXPrecompilePreamble,
2265 CXXChainedPCH));
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002266
Argyrios Kyrtzidis026f6912010-11-18 21:47:04 +00002267 if (NumErrors != Diags->getClient()->getNumErrors()) {
Douglas Gregorb10daed2010-10-11 16:52:23 +00002268 // Make sure to check that 'Unit' is non-NULL.
2269 if (CXXIdx->getDisplayDiagnostics() && Unit.get()) {
2270 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
2271 DEnd = Unit->stored_diag_end();
2272 D != DEnd; ++D) {
2273 CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions());
2274 CXString Msg = clang_formatDiagnostic(&Diag,
2275 clang_defaultDiagnosticDisplayOptions());
2276 fprintf(stderr, "%s\n", clang_getCString(Msg));
2277 clang_disposeString(Msg);
2278 }
Douglas Gregor274f1902010-02-22 23:17:23 +00002279#ifdef LLVM_ON_WIN32
Douglas Gregorb10daed2010-10-11 16:52:23 +00002280 // On Windows, force a flush, since there may be multiple copies of
2281 // stderr and stdout in the file system, all with different buffers
2282 // but writing to the same device.
2283 fflush(stderr);
2284#endif
2285 }
Douglas Gregora88084b2010-02-18 18:08:43 +00002286 }
Douglas Gregord93256e2010-01-28 06:00:51 +00002287
Ted Kremeneka60ed472010-11-16 08:15:36 +00002288 PTUI->result = MakeCXTranslationUnit(Unit.take());
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002289}
2290CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx,
2291 const char *source_filename,
Douglas Gregor2ef69442010-09-01 16:43:19 +00002292 const char * const *command_line_args,
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002293 int num_command_line_args,
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00002294 struct CXUnsavedFile *unsaved_files,
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002295 unsigned num_unsaved_files,
2296 unsigned options) {
2297 ParseTranslationUnitInfo PTUI = { CIdx, source_filename, command_line_args,
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00002298 num_command_line_args, unsaved_files,
2299 num_unsaved_files, options, 0 };
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002300 llvm::CrashRecoveryContext CRC;
2301
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00002302 if (!RunSafely(CRC, clang_parseTranslationUnit_Impl, &PTUI)) {
Daniel Dunbar60a45432010-08-23 22:35:34 +00002303 fprintf(stderr, "libclang: crash detected during parsing: {\n");
2304 fprintf(stderr, " 'source_filename' : '%s'\n", source_filename);
2305 fprintf(stderr, " 'command_line_args' : [");
2306 for (int i = 0; i != num_command_line_args; ++i) {
2307 if (i)
2308 fprintf(stderr, ", ");
2309 fprintf(stderr, "'%s'", command_line_args[i]);
2310 }
2311 fprintf(stderr, "],\n");
2312 fprintf(stderr, " 'unsaved_files' : [");
2313 for (unsigned i = 0; i != num_unsaved_files; ++i) {
2314 if (i)
2315 fprintf(stderr, ", ");
2316 fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
2317 unsaved_files[i].Length);
2318 }
2319 fprintf(stderr, "],\n");
2320 fprintf(stderr, " 'options' : %d,\n", options);
2321 fprintf(stderr, "}\n");
2322
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002323 return 0;
2324 }
2325
2326 return PTUI.result;
Steve Naroff5b7d8e22009-10-15 20:04:39 +00002327}
2328
Douglas Gregor19998442010-08-13 15:35:05 +00002329unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
2330 return CXSaveTranslationUnit_None;
2331}
2332
2333int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
2334 unsigned options) {
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002335 if (!TU)
2336 return 1;
2337
Ted Kremeneka60ed472010-11-16 08:15:36 +00002338 return static_cast<ASTUnit *>(TU->TUData)->Save(FileName);
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002339}
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002340
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002341void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002342 if (CTUnit) {
2343 // If the translation unit has been marked as unsafe to free, just discard
2344 // it.
Ted Kremeneka60ed472010-11-16 08:15:36 +00002345 if (static_cast<ASTUnit *>(CTUnit->TUData)->isUnsafeToFree())
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002346 return;
2347
Ted Kremeneka60ed472010-11-16 08:15:36 +00002348 delete static_cast<ASTUnit *>(CTUnit->TUData);
2349 disposeCXStringPool(CTUnit->StringPool);
2350 delete CTUnit;
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002351 }
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00002352}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002353
Douglas Gregore1e13bf2010-08-11 15:58:42 +00002354unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
2355 return CXReparse_None;
2356}
2357
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002358struct ReparseTranslationUnitInfo {
2359 CXTranslationUnit TU;
2360 unsigned num_unsaved_files;
2361 struct CXUnsavedFile *unsaved_files;
2362 unsigned options;
2363 int result;
2364};
Douglas Gregor593b0c12010-09-23 18:47:53 +00002365
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00002366static void clang_reparseTranslationUnit_Impl(void *UserData) {
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002367 ReparseTranslationUnitInfo *RTUI =
2368 static_cast<ReparseTranslationUnitInfo*>(UserData);
2369 CXTranslationUnit TU = RTUI->TU;
2370 unsigned num_unsaved_files = RTUI->num_unsaved_files;
2371 struct CXUnsavedFile *unsaved_files = RTUI->unsaved_files;
2372 unsigned options = RTUI->options;
2373 (void) options;
2374 RTUI->result = 1;
2375
Douglas Gregorabc563f2010-07-19 21:46:24 +00002376 if (!TU)
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002377 return;
Douglas Gregor593b0c12010-09-23 18:47:53 +00002378
Ted Kremeneka60ed472010-11-16 08:15:36 +00002379 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregor593b0c12010-09-23 18:47:53 +00002380 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Douglas Gregorabc563f2010-07-19 21:46:24 +00002381
2382 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
2383 for (unsigned I = 0; I != num_unsaved_files; ++I) {
2384 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
2385 const llvm::MemoryBuffer *Buffer
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002386 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
Douglas Gregorabc563f2010-07-19 21:46:24 +00002387 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2388 Buffer));
2389 }
2390
Douglas Gregor593b0c12010-09-23 18:47:53 +00002391 if (!CXXUnit->Reparse(RemappedFiles.data(), RemappedFiles.size()))
2392 RTUI->result = 0;
Douglas Gregorabc563f2010-07-19 21:46:24 +00002393}
Douglas Gregor593b0c12010-09-23 18:47:53 +00002394
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002395int clang_reparseTranslationUnit(CXTranslationUnit TU,
2396 unsigned num_unsaved_files,
2397 struct CXUnsavedFile *unsaved_files,
2398 unsigned options) {
2399 ReparseTranslationUnitInfo RTUI = { TU, num_unsaved_files, unsaved_files,
2400 options, 0 };
2401 llvm::CrashRecoveryContext CRC;
2402
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00002403 if (!RunSafely(CRC, clang_reparseTranslationUnit_Impl, &RTUI)) {
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00002404 fprintf(stderr, "libclang: crash detected during reparsing\n");
Ted Kremeneka60ed472010-11-16 08:15:36 +00002405 static_cast<ASTUnit *>(TU->TUData)->setUnsafeToFree(true);
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002406 return 1;
2407 }
2408
Ted Kremenek1dfb26a2010-10-29 01:06:50 +00002409
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002410 return RTUI.result;
2411}
2412
Douglas Gregordf95a132010-08-09 20:45:32 +00002413
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002414CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002415 if (!CTUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002416 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002417
Ted Kremeneka60ed472010-11-16 08:15:36 +00002418 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit->TUData);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002419 return createCXString(CXXUnit->getOriginalSourceFileName(), true);
Steve Naroffaf08ddc2009-09-03 15:49:00 +00002420}
Daniel Dunbar1eb79b52009-08-28 16:30:07 +00002421
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002422CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002423 CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } };
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002424 return Result;
2425}
2426
Ted Kremenekfb480492010-01-13 21:46:36 +00002427} // end: extern "C"
Steve Naroff600866c2009-08-27 19:51:58 +00002428
Ted Kremenekfb480492010-01-13 21:46:36 +00002429//===----------------------------------------------------------------------===//
Douglas Gregor1db19de2010-01-19 21:36:55 +00002430// CXSourceLocation and CXSourceRange Operations.
2431//===----------------------------------------------------------------------===//
2432
Douglas Gregorb9790342010-01-22 21:44:22 +00002433extern "C" {
2434CXSourceLocation clang_getNullLocation() {
Douglas Gregor5352ac02010-01-28 00:27:43 +00002435 CXSourceLocation Result = { { 0, 0 }, 0 };
Douglas Gregorb9790342010-01-22 21:44:22 +00002436 return Result;
2437}
2438
2439unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) {
Daniel Dunbar90a6b9e2010-01-30 23:58:27 +00002440 return (loc1.ptr_data[0] == loc2.ptr_data[0] &&
2441 loc1.ptr_data[1] == loc2.ptr_data[1] &&
2442 loc1.int_data == loc2.int_data);
Douglas Gregorb9790342010-01-22 21:44:22 +00002443}
2444
2445CXSourceLocation clang_getLocation(CXTranslationUnit tu,
2446 CXFile file,
2447 unsigned line,
2448 unsigned column) {
Douglas Gregor42748ec2010-04-30 19:45:53 +00002449 if (!tu || !file)
Douglas Gregorb9790342010-01-22 21:44:22 +00002450 return clang_getNullLocation();
Douglas Gregor42748ec2010-04-30 19:45:53 +00002451
Ted Kremeneka60ed472010-11-16 08:15:36 +00002452 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
Douglas Gregorb9790342010-01-22 21:44:22 +00002453 SourceLocation SLoc
2454 = CXXUnit->getSourceManager().getLocation(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002455 static_cast<const FileEntry *>(file),
Douglas Gregorb9790342010-01-22 21:44:22 +00002456 line, column);
David Chisnall83889a72010-10-15 17:07:39 +00002457 if (SLoc.isInvalid()) return clang_getNullLocation();
2458
2459 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
2460}
2461
2462CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
2463 CXFile file,
2464 unsigned offset) {
2465 if (!tu || !file)
2466 return clang_getNullLocation();
2467
Ted Kremeneka60ed472010-11-16 08:15:36 +00002468 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
David Chisnall83889a72010-10-15 17:07:39 +00002469 SourceLocation Start
2470 = CXXUnit->getSourceManager().getLocation(
2471 static_cast<const FileEntry *>(file),
2472 1, 1);
2473 if (Start.isInvalid()) return clang_getNullLocation();
2474
2475 SourceLocation SLoc = Start.getFileLocWithOffset(offset);
2476
2477 if (SLoc.isInvalid()) return clang_getNullLocation();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002478
Ted Kremenek1a9a0bc2010-06-28 23:54:17 +00002479 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
Douglas Gregorb9790342010-01-22 21:44:22 +00002480}
2481
Douglas Gregor5352ac02010-01-28 00:27:43 +00002482CXSourceRange clang_getNullRange() {
2483 CXSourceRange Result = { { 0, 0 }, 0, 0 };
2484 return Result;
2485}
Daniel Dunbard52864b2010-02-14 10:02:57 +00002486
Douglas Gregor5352ac02010-01-28 00:27:43 +00002487CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) {
2488 if (begin.ptr_data[0] != end.ptr_data[0] ||
2489 begin.ptr_data[1] != end.ptr_data[1])
2490 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002491
2492 CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002493 begin.int_data, end.int_data };
Douglas Gregorb9790342010-01-22 21:44:22 +00002494 return Result;
2495}
2496
Douglas Gregor46766dc2010-01-26 19:19:08 +00002497void clang_getInstantiationLocation(CXSourceLocation location,
2498 CXFile *file,
2499 unsigned *line,
2500 unsigned *column,
2501 unsigned *offset) {
Douglas Gregor1db19de2010-01-19 21:36:55 +00002502 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2503
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002504 if (!location.ptr_data[0] || Loc.isInvalid()) {
Douglas Gregor46766dc2010-01-26 19:19:08 +00002505 if (file)
2506 *file = 0;
2507 if (line)
2508 *line = 0;
2509 if (column)
2510 *column = 0;
2511 if (offset)
2512 *offset = 0;
2513 return;
2514 }
2515
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002516 const SourceManager &SM =
2517 *static_cast<const SourceManager*>(location.ptr_data[0]);
Douglas Gregor1db19de2010-01-19 21:36:55 +00002518 SourceLocation InstLoc = SM.getInstantiationLoc(Loc);
Douglas Gregor1db19de2010-01-19 21:36:55 +00002519
2520 if (file)
2521 *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc));
2522 if (line)
2523 *line = SM.getInstantiationLineNumber(InstLoc);
2524 if (column)
2525 *column = SM.getInstantiationColumnNumber(InstLoc);
Douglas Gregore69517c2010-01-26 03:07:15 +00002526 if (offset)
Douglas Gregor46766dc2010-01-26 19:19:08 +00002527 *offset = SM.getDecomposedLoc(InstLoc).second;
Douglas Gregore69517c2010-01-26 03:07:15 +00002528}
2529
Douglas Gregora9b06d42010-11-09 06:24:54 +00002530void clang_getSpellingLocation(CXSourceLocation location,
2531 CXFile *file,
2532 unsigned *line,
2533 unsigned *column,
2534 unsigned *offset) {
2535 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2536
2537 if (!location.ptr_data[0] || Loc.isInvalid()) {
2538 if (file)
2539 *file = 0;
2540 if (line)
2541 *line = 0;
2542 if (column)
2543 *column = 0;
2544 if (offset)
2545 *offset = 0;
2546 return;
2547 }
2548
2549 const SourceManager &SM =
2550 *static_cast<const SourceManager*>(location.ptr_data[0]);
2551 SourceLocation SpellLoc = Loc;
2552 if (SpellLoc.isMacroID()) {
2553 SourceLocation SimpleSpellingLoc = SM.getImmediateSpellingLoc(SpellLoc);
2554 if (SimpleSpellingLoc.isFileID() &&
2555 SM.getFileEntryForID(SM.getDecomposedLoc(SimpleSpellingLoc).first))
2556 SpellLoc = SimpleSpellingLoc;
2557 else
2558 SpellLoc = SM.getInstantiationLoc(SpellLoc);
2559 }
2560
2561 std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(SpellLoc);
2562 FileID FID = LocInfo.first;
2563 unsigned FileOffset = LocInfo.second;
2564
2565 if (file)
2566 *file = (void *)SM.getFileEntryForID(FID);
2567 if (line)
2568 *line = SM.getLineNumber(FID, FileOffset);
2569 if (column)
2570 *column = SM.getColumnNumber(FID, FileOffset);
2571 if (offset)
2572 *offset = FileOffset;
2573}
2574
Douglas Gregor1db19de2010-01-19 21:36:55 +00002575CXSourceLocation clang_getRangeStart(CXSourceRange range) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002576 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002577 range.begin_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00002578 return Result;
2579}
2580
2581CXSourceLocation clang_getRangeEnd(CXSourceRange range) {
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002582 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002583 range.end_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00002584 return Result;
2585}
2586
Douglas Gregorb9790342010-01-22 21:44:22 +00002587} // end: extern "C"
2588
Douglas Gregor1db19de2010-01-19 21:36:55 +00002589//===----------------------------------------------------------------------===//
Ted Kremenekfb480492010-01-13 21:46:36 +00002590// CXFile Operations.
2591//===----------------------------------------------------------------------===//
2592
2593extern "C" {
Ted Kremenek74844072010-02-17 00:41:20 +00002594CXString clang_getFileName(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00002595 if (!SFile)
Ted Kremeneka60ed472010-11-16 08:15:36 +00002596 return createCXString((const char*)NULL);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002597
Steve Naroff88145032009-10-27 14:35:18 +00002598 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
Ted Kremenek74844072010-02-17 00:41:20 +00002599 return createCXString(FEnt->getName());
Steve Naroff88145032009-10-27 14:35:18 +00002600}
2601
2602time_t clang_getFileTime(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00002603 if (!SFile)
2604 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002605
Steve Naroff88145032009-10-27 14:35:18 +00002606 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
2607 return FEnt->getModificationTime();
Steve Naroffee9405e2009-09-25 21:45:39 +00002608}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002609
Douglas Gregorb9790342010-01-22 21:44:22 +00002610CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) {
2611 if (!tu)
2612 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002613
Ted Kremeneka60ed472010-11-16 08:15:36 +00002614 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002615
Douglas Gregorb9790342010-01-22 21:44:22 +00002616 FileManager &FMgr = CXXUnit->getFileManager();
Chris Lattner39b49bc2010-11-23 08:35:12 +00002617 return const_cast<FileEntry *>(FMgr.getFile(file_name));
Douglas Gregorb9790342010-01-22 21:44:22 +00002618}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002619
Ted Kremenekfb480492010-01-13 21:46:36 +00002620} // end: extern "C"
Steve Naroffee9405e2009-09-25 21:45:39 +00002621
Ted Kremenekfb480492010-01-13 21:46:36 +00002622//===----------------------------------------------------------------------===//
2623// CXCursor Operations.
2624//===----------------------------------------------------------------------===//
2625
Ted Kremenekfb480492010-01-13 21:46:36 +00002626static Decl *getDeclFromExpr(Stmt *E) {
Douglas Gregordb1314e2010-10-01 21:11:22 +00002627 if (CastExpr *CE = dyn_cast<CastExpr>(E))
2628 return getDeclFromExpr(CE->getSubExpr());
2629
Ted Kremenekfb480492010-01-13 21:46:36 +00002630 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
2631 return RefExpr->getDecl();
Douglas Gregor38f28c12010-10-22 22:24:08 +00002632 if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
2633 return RefExpr->getDecl();
Ted Kremenekfb480492010-01-13 21:46:36 +00002634 if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
2635 return ME->getMemberDecl();
2636 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
2637 return RE->getDecl();
Douglas Gregordb1314e2010-10-01 21:11:22 +00002638 if (ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E))
John McCall12f78a62010-12-02 01:19:52 +00002639 return PRE->isExplicitProperty() ? PRE->getExplicitProperty() : 0;
Douglas Gregordb1314e2010-10-01 21:11:22 +00002640
Ted Kremenekfb480492010-01-13 21:46:36 +00002641 if (CallExpr *CE = dyn_cast<CallExpr>(E))
2642 return getDeclFromExpr(CE->getCallee());
Douglas Gregor93798e22010-11-05 21:11:19 +00002643 if (CXXConstructExpr *CE = llvm::dyn_cast<CXXConstructExpr>(E))
2644 if (!CE->isElidable())
2645 return CE->getConstructor();
Ted Kremenekfb480492010-01-13 21:46:36 +00002646 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
2647 return OME->getMethodDecl();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002648
Douglas Gregordb1314e2010-10-01 21:11:22 +00002649 if (ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E))
2650 return PE->getProtocol();
2651
Ted Kremenekfb480492010-01-13 21:46:36 +00002652 return 0;
2653}
2654
Daniel Dunbarc29f4c32010-02-02 05:00:22 +00002655static SourceLocation getLocationFromExpr(Expr *E) {
2656 if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
2657 return /*FIXME:*/Msg->getLeftLoc();
2658 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
2659 return DRE->getLocation();
Douglas Gregor38f28c12010-10-22 22:24:08 +00002660 if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
2661 return RefExpr->getLocation();
Daniel Dunbarc29f4c32010-02-02 05:00:22 +00002662 if (MemberExpr *Member = dyn_cast<MemberExpr>(E))
2663 return Member->getMemberLoc();
2664 if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
2665 return Ivar->getLocation();
2666 return E->getLocStart();
2667}
2668
Ted Kremenekfb480492010-01-13 21:46:36 +00002669extern "C" {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002670
2671unsigned clang_visitChildren(CXCursor parent,
Douglas Gregorb1373d02010-01-20 20:59:29 +00002672 CXCursorVisitor visitor,
2673 CXClientData client_data) {
Ted Kremeneka60ed472010-11-16 08:15:36 +00002674 CursorVisitor CursorVis(getCursorTU(parent), visitor, client_data,
2675 getCursorASTUnit(parent)->getMaxPCHLevel());
Douglas Gregorb1373d02010-01-20 20:59:29 +00002676 return CursorVis.VisitChildren(parent);
2677}
2678
David Chisnall3387c652010-11-03 14:12:26 +00002679#ifndef __has_feature
2680#define __has_feature(x) 0
2681#endif
2682#if __has_feature(blocks)
2683typedef enum CXChildVisitResult
2684 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
2685
2686static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
2687 CXClientData client_data) {
2688 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
2689 return block(cursor, parent);
2690}
2691#else
2692// If we are compiled with a compiler that doesn't have native blocks support,
2693// define and call the block manually, so the
2694typedef struct _CXChildVisitResult
2695{
2696 void *isa;
2697 int flags;
2698 int reserved;
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00002699 enum CXChildVisitResult(*invoke)(struct _CXChildVisitResult*, CXCursor,
2700 CXCursor);
David Chisnall3387c652010-11-03 14:12:26 +00002701} *CXCursorVisitorBlock;
2702
2703static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
2704 CXClientData client_data) {
2705 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
2706 return block->invoke(block, cursor, parent);
2707}
2708#endif
2709
2710
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00002711unsigned clang_visitChildrenWithBlock(CXCursor parent,
2712 CXCursorVisitorBlock block) {
David Chisnall3387c652010-11-03 14:12:26 +00002713 return clang_visitChildren(parent, visitWithBlock, block);
2714}
2715
Douglas Gregor78205d42010-01-20 21:45:58 +00002716static CXString getDeclSpelling(Decl *D) {
2717 NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D);
Douglas Gregore3c60a72010-11-17 00:13:31 +00002718 if (!ND) {
2719 if (ObjCPropertyImplDecl *PropImpl =llvm::dyn_cast<ObjCPropertyImplDecl>(D))
2720 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
2721 return createCXString(Property->getIdentifier()->getName());
2722
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002723 return createCXString("");
Douglas Gregore3c60a72010-11-17 00:13:31 +00002724 }
2725
Douglas Gregor78205d42010-01-20 21:45:58 +00002726 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002727 return createCXString(OMD->getSelector().getAsString());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002728
Douglas Gregor78205d42010-01-20 21:45:58 +00002729 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
2730 // No, this isn't the same as the code below. getIdentifier() is non-virtual
2731 // and returns different names. NamedDecl returns the class name and
2732 // ObjCCategoryImplDecl returns the category name.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002733 return createCXString(CIMP->getIdentifier()->getNameStart());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002734
Douglas Gregor0a35bce2010-09-01 03:07:18 +00002735 if (isa<UsingDirectiveDecl>(D))
2736 return createCXString("");
2737
Ted Kremenek50aa6ac2010-05-19 21:51:10 +00002738 llvm::SmallString<1024> S;
2739 llvm::raw_svector_ostream os(S);
2740 ND->printName(os);
2741
2742 return createCXString(os.str());
Douglas Gregor78205d42010-01-20 21:45:58 +00002743}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002744
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002745CXString clang_getCursorSpelling(CXCursor C) {
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002746 if (clang_isTranslationUnit(C.kind))
Ted Kremeneka60ed472010-11-16 08:15:36 +00002747 return clang_getTranslationUnitSpelling(
2748 static_cast<CXTranslationUnit>(C.data[2]));
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002749
Steve Narofff334b4e2009-09-02 18:26:48 +00002750 if (clang_isReference(C.kind)) {
2751 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +00002752 case CXCursor_ObjCSuperClassRef: {
Douglas Gregor2e331b92010-01-16 14:00:32 +00002753 ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002754 return createCXString(Super->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00002755 }
2756 case CXCursor_ObjCClassRef: {
Douglas Gregor1adb0822010-01-16 17:14:40 +00002757 ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002758 return createCXString(Class->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00002759 }
2760 case CXCursor_ObjCProtocolRef: {
Douglas Gregor78db0cd2010-01-16 15:44:18 +00002761 ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
Douglas Gregorf46034a2010-01-18 23:41:10 +00002762 assert(OID && "getCursorSpelling(): Missing protocol decl");
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002763 return createCXString(OID->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00002764 }
Ted Kremenek3064ef92010-08-27 21:34:58 +00002765 case CXCursor_CXXBaseSpecifier: {
2766 CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
2767 return createCXString(B->getType().getAsString());
2768 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002769 case CXCursor_TypeRef: {
2770 TypeDecl *Type = getCursorTypeRef(C).first;
2771 assert(Type && "Missing type decl");
2772
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002773 return createCXString(getCursorContext(C).getTypeDeclType(Type).
2774 getAsString());
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002775 }
Douglas Gregor0b36e612010-08-31 20:37:03 +00002776 case CXCursor_TemplateRef: {
2777 TemplateDecl *Template = getCursorTemplateRef(C).first;
Douglas Gregor69319002010-08-31 23:48:11 +00002778 assert(Template && "Missing template decl");
Douglas Gregor0b36e612010-08-31 20:37:03 +00002779
2780 return createCXString(Template->getNameAsString());
2781 }
Douglas Gregor69319002010-08-31 23:48:11 +00002782
2783 case CXCursor_NamespaceRef: {
2784 NamedDecl *NS = getCursorNamespaceRef(C).first;
2785 assert(NS && "Missing namespace decl");
2786
2787 return createCXString(NS->getNameAsString());
2788 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002789
Douglas Gregora67e03f2010-09-09 21:42:20 +00002790 case CXCursor_MemberRef: {
2791 FieldDecl *Field = getCursorMemberRef(C).first;
2792 assert(Field && "Missing member decl");
2793
2794 return createCXString(Field->getNameAsString());
2795 }
2796
Douglas Gregor36897b02010-09-10 00:22:18 +00002797 case CXCursor_LabelRef: {
2798 LabelStmt *Label = getCursorLabelRef(C).first;
2799 assert(Label && "Missing label");
2800
2801 return createCXString(Label->getID()->getName());
2802 }
2803
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00002804 case CXCursor_OverloadedDeclRef: {
2805 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
2806 if (Decl *D = Storage.dyn_cast<Decl *>()) {
2807 if (NamedDecl *ND = dyn_cast<NamedDecl>(D))
2808 return createCXString(ND->getNameAsString());
2809 return createCXString("");
2810 }
2811 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
2812 return createCXString(E->getName().getAsString());
2813 OverloadedTemplateStorage *Ovl
2814 = Storage.get<OverloadedTemplateStorage*>();
2815 if (Ovl->size() == 0)
2816 return createCXString("");
2817 return createCXString((*Ovl->begin())->getNameAsString());
2818 }
2819
Daniel Dunbaracca7252009-11-30 20:42:49 +00002820 default:
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002821 return createCXString("<not implemented>");
Steve Narofff334b4e2009-09-02 18:26:48 +00002822 }
2823 }
Douglas Gregor97b98722010-01-19 23:20:36 +00002824
2825 if (clang_isExpression(C.kind)) {
2826 Decl *D = getDeclFromExpr(getCursorExpr(C));
2827 if (D)
Douglas Gregor78205d42010-01-20 21:45:58 +00002828 return getDeclSpelling(D);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002829 return createCXString("");
Douglas Gregor97b98722010-01-19 23:20:36 +00002830 }
2831
Douglas Gregor36897b02010-09-10 00:22:18 +00002832 if (clang_isStatement(C.kind)) {
2833 Stmt *S = getCursorStmt(C);
2834 if (LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S))
2835 return createCXString(Label->getID()->getName());
2836
2837 return createCXString("");
2838 }
2839
Douglas Gregor4ae8f292010-03-18 17:52:52 +00002840 if (C.kind == CXCursor_MacroInstantiation)
2841 return createCXString(getCursorMacroInstantiation(C)->getName()
2842 ->getNameStart());
2843
Douglas Gregor572feb22010-03-18 18:04:21 +00002844 if (C.kind == CXCursor_MacroDefinition)
2845 return createCXString(getCursorMacroDefinition(C)->getName()
2846 ->getNameStart());
2847
Douglas Gregorecdcb882010-10-20 22:00:55 +00002848 if (C.kind == CXCursor_InclusionDirective)
2849 return createCXString(getCursorInclusionDirective(C)->getFileName());
2850
Douglas Gregor60cbfac2010-01-25 16:56:17 +00002851 if (clang_isDeclaration(C.kind))
2852 return getDeclSpelling(getCursorDecl(C));
Ted Kremeneke68fff62010-02-17 00:41:32 +00002853
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002854 return createCXString("");
Steve Narofff334b4e2009-09-02 18:26:48 +00002855}
2856
Douglas Gregor358559d2010-10-02 22:49:11 +00002857CXString clang_getCursorDisplayName(CXCursor C) {
2858 if (!clang_isDeclaration(C.kind))
2859 return clang_getCursorSpelling(C);
2860
2861 Decl *D = getCursorDecl(C);
2862 if (!D)
2863 return createCXString("");
2864
2865 PrintingPolicy &Policy = getCursorContext(C).PrintingPolicy;
2866 if (FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D))
2867 D = FunTmpl->getTemplatedDecl();
2868
2869 if (FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
2870 llvm::SmallString<64> Str;
2871 llvm::raw_svector_ostream OS(Str);
2872 OS << Function->getNameAsString();
2873 if (Function->getPrimaryTemplate())
2874 OS << "<>";
2875 OS << "(";
2876 for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) {
2877 if (I)
2878 OS << ", ";
2879 OS << Function->getParamDecl(I)->getType().getAsString(Policy);
2880 }
2881
2882 if (Function->isVariadic()) {
2883 if (Function->getNumParams())
2884 OS << ", ";
2885 OS << "...";
2886 }
2887 OS << ")";
2888 return createCXString(OS.str());
2889 }
2890
2891 if (ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) {
2892 llvm::SmallString<64> Str;
2893 llvm::raw_svector_ostream OS(Str);
2894 OS << ClassTemplate->getNameAsString();
2895 OS << "<";
2896 TemplateParameterList *Params = ClassTemplate->getTemplateParameters();
2897 for (unsigned I = 0, N = Params->size(); I != N; ++I) {
2898 if (I)
2899 OS << ", ";
2900
2901 NamedDecl *Param = Params->getParam(I);
2902 if (Param->getIdentifier()) {
2903 OS << Param->getIdentifier()->getName();
2904 continue;
2905 }
2906
2907 // There is no parameter name, which makes this tricky. Try to come up
2908 // with something useful that isn't too long.
2909 if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
2910 OS << (TTP->wasDeclaredWithTypename()? "typename" : "class");
2911 else if (NonTypeTemplateParmDecl *NTTP
2912 = dyn_cast<NonTypeTemplateParmDecl>(Param))
2913 OS << NTTP->getType().getAsString(Policy);
2914 else
2915 OS << "template<...> class";
2916 }
2917
2918 OS << ">";
2919 return createCXString(OS.str());
2920 }
2921
2922 if (ClassTemplateSpecializationDecl *ClassSpec
2923 = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
2924 // If the type was explicitly written, use that.
2925 if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten())
2926 return createCXString(TSInfo->getType().getAsString(Policy));
2927
2928 llvm::SmallString<64> Str;
2929 llvm::raw_svector_ostream OS(Str);
2930 OS << ClassSpec->getNameAsString();
2931 OS << TemplateSpecializationType::PrintTemplateArgumentList(
Douglas Gregor910f8002010-11-07 23:05:16 +00002932 ClassSpec->getTemplateArgs().data(),
2933 ClassSpec->getTemplateArgs().size(),
Douglas Gregor358559d2010-10-02 22:49:11 +00002934 Policy);
2935 return createCXString(OS.str());
2936 }
2937
2938 return clang_getCursorSpelling(C);
2939}
2940
Ted Kremeneke68fff62010-02-17 00:41:32 +00002941CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
Steve Naroff89922f82009-08-31 00:59:03 +00002942 switch (Kind) {
Ted Kremeneke68fff62010-02-17 00:41:32 +00002943 case CXCursor_FunctionDecl:
2944 return createCXString("FunctionDecl");
2945 case CXCursor_TypedefDecl:
2946 return createCXString("TypedefDecl");
2947 case CXCursor_EnumDecl:
2948 return createCXString("EnumDecl");
2949 case CXCursor_EnumConstantDecl:
2950 return createCXString("EnumConstantDecl");
2951 case CXCursor_StructDecl:
2952 return createCXString("StructDecl");
2953 case CXCursor_UnionDecl:
2954 return createCXString("UnionDecl");
2955 case CXCursor_ClassDecl:
2956 return createCXString("ClassDecl");
2957 case CXCursor_FieldDecl:
2958 return createCXString("FieldDecl");
2959 case CXCursor_VarDecl:
2960 return createCXString("VarDecl");
2961 case CXCursor_ParmDecl:
2962 return createCXString("ParmDecl");
2963 case CXCursor_ObjCInterfaceDecl:
2964 return createCXString("ObjCInterfaceDecl");
2965 case CXCursor_ObjCCategoryDecl:
2966 return createCXString("ObjCCategoryDecl");
2967 case CXCursor_ObjCProtocolDecl:
2968 return createCXString("ObjCProtocolDecl");
2969 case CXCursor_ObjCPropertyDecl:
2970 return createCXString("ObjCPropertyDecl");
2971 case CXCursor_ObjCIvarDecl:
2972 return createCXString("ObjCIvarDecl");
2973 case CXCursor_ObjCInstanceMethodDecl:
2974 return createCXString("ObjCInstanceMethodDecl");
2975 case CXCursor_ObjCClassMethodDecl:
2976 return createCXString("ObjCClassMethodDecl");
2977 case CXCursor_ObjCImplementationDecl:
2978 return createCXString("ObjCImplementationDecl");
2979 case CXCursor_ObjCCategoryImplDecl:
2980 return createCXString("ObjCCategoryImplDecl");
Ted Kremenek8bd5a692010-04-13 23:39:06 +00002981 case CXCursor_CXXMethod:
2982 return createCXString("CXXMethod");
Ted Kremeneke68fff62010-02-17 00:41:32 +00002983 case CXCursor_UnexposedDecl:
2984 return createCXString("UnexposedDecl");
2985 case CXCursor_ObjCSuperClassRef:
2986 return createCXString("ObjCSuperClassRef");
2987 case CXCursor_ObjCProtocolRef:
2988 return createCXString("ObjCProtocolRef");
2989 case CXCursor_ObjCClassRef:
2990 return createCXString("ObjCClassRef");
2991 case CXCursor_TypeRef:
2992 return createCXString("TypeRef");
Douglas Gregor0b36e612010-08-31 20:37:03 +00002993 case CXCursor_TemplateRef:
2994 return createCXString("TemplateRef");
Douglas Gregor69319002010-08-31 23:48:11 +00002995 case CXCursor_NamespaceRef:
2996 return createCXString("NamespaceRef");
Douglas Gregora67e03f2010-09-09 21:42:20 +00002997 case CXCursor_MemberRef:
2998 return createCXString("MemberRef");
Douglas Gregor36897b02010-09-10 00:22:18 +00002999 case CXCursor_LabelRef:
3000 return createCXString("LabelRef");
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003001 case CXCursor_OverloadedDeclRef:
3002 return createCXString("OverloadedDeclRef");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003003 case CXCursor_UnexposedExpr:
3004 return createCXString("UnexposedExpr");
Ted Kremenek1ee6cad2010-04-11 21:47:37 +00003005 case CXCursor_BlockExpr:
3006 return createCXString("BlockExpr");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003007 case CXCursor_DeclRefExpr:
3008 return createCXString("DeclRefExpr");
3009 case CXCursor_MemberRefExpr:
3010 return createCXString("MemberRefExpr");
3011 case CXCursor_CallExpr:
3012 return createCXString("CallExpr");
3013 case CXCursor_ObjCMessageExpr:
3014 return createCXString("ObjCMessageExpr");
3015 case CXCursor_UnexposedStmt:
3016 return createCXString("UnexposedStmt");
Douglas Gregor36897b02010-09-10 00:22:18 +00003017 case CXCursor_LabelStmt:
3018 return createCXString("LabelStmt");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003019 case CXCursor_InvalidFile:
3020 return createCXString("InvalidFile");
Ted Kremenek292db642010-03-19 20:39:05 +00003021 case CXCursor_InvalidCode:
3022 return createCXString("InvalidCode");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003023 case CXCursor_NoDeclFound:
3024 return createCXString("NoDeclFound");
3025 case CXCursor_NotImplemented:
3026 return createCXString("NotImplemented");
3027 case CXCursor_TranslationUnit:
3028 return createCXString("TranslationUnit");
Ted Kremeneke77f4432010-02-18 03:09:07 +00003029 case CXCursor_UnexposedAttr:
3030 return createCXString("UnexposedAttr");
3031 case CXCursor_IBActionAttr:
3032 return createCXString("attribute(ibaction)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003033 case CXCursor_IBOutletAttr:
3034 return createCXString("attribute(iboutlet)");
Ted Kremenek857e9182010-05-19 17:38:06 +00003035 case CXCursor_IBOutletCollectionAttr:
3036 return createCXString("attribute(iboutletcollection)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003037 case CXCursor_PreprocessingDirective:
3038 return createCXString("preprocessing directive");
Douglas Gregor572feb22010-03-18 18:04:21 +00003039 case CXCursor_MacroDefinition:
3040 return createCXString("macro definition");
Douglas Gregor48072312010-03-18 15:23:44 +00003041 case CXCursor_MacroInstantiation:
3042 return createCXString("macro instantiation");
Douglas Gregorecdcb882010-10-20 22:00:55 +00003043 case CXCursor_InclusionDirective:
3044 return createCXString("inclusion directive");
Ted Kremenek8f06e0e2010-05-06 23:38:21 +00003045 case CXCursor_Namespace:
3046 return createCXString("Namespace");
Ted Kremeneka0536d82010-05-07 01:04:29 +00003047 case CXCursor_LinkageSpec:
3048 return createCXString("LinkageSpec");
Ted Kremenek3064ef92010-08-27 21:34:58 +00003049 case CXCursor_CXXBaseSpecifier:
3050 return createCXString("C++ base class specifier");
Douglas Gregor01829d32010-08-31 14:41:23 +00003051 case CXCursor_Constructor:
3052 return createCXString("CXXConstructor");
3053 case CXCursor_Destructor:
3054 return createCXString("CXXDestructor");
3055 case CXCursor_ConversionFunction:
3056 return createCXString("CXXConversion");
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00003057 case CXCursor_TemplateTypeParameter:
3058 return createCXString("TemplateTypeParameter");
3059 case CXCursor_NonTypeTemplateParameter:
3060 return createCXString("NonTypeTemplateParameter");
3061 case CXCursor_TemplateTemplateParameter:
3062 return createCXString("TemplateTemplateParameter");
3063 case CXCursor_FunctionTemplate:
3064 return createCXString("FunctionTemplate");
Douglas Gregor39d6f072010-08-31 19:02:00 +00003065 case CXCursor_ClassTemplate:
3066 return createCXString("ClassTemplate");
Douglas Gregor74dbe642010-08-31 19:31:58 +00003067 case CXCursor_ClassTemplatePartialSpecialization:
3068 return createCXString("ClassTemplatePartialSpecialization");
Douglas Gregor69319002010-08-31 23:48:11 +00003069 case CXCursor_NamespaceAlias:
3070 return createCXString("NamespaceAlias");
Douglas Gregor0a35bce2010-09-01 03:07:18 +00003071 case CXCursor_UsingDirective:
3072 return createCXString("UsingDirective");
Douglas Gregor7e242562010-09-01 19:52:22 +00003073 case CXCursor_UsingDeclaration:
3074 return createCXString("UsingDeclaration");
Steve Naroff89922f82009-08-31 00:59:03 +00003075 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00003076
Ted Kremenekdeb06bd2010-01-16 02:02:09 +00003077 llvm_unreachable("Unhandled CXCursorKind");
Ted Kremeneka60ed472010-11-16 08:15:36 +00003078 return createCXString((const char*) 0);
Steve Naroff600866c2009-08-27 19:51:58 +00003079}
Steve Naroff89922f82009-08-31 00:59:03 +00003080
Ted Kremeneke68fff62010-02-17 00:41:32 +00003081enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
3082 CXCursor parent,
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003083 CXClientData client_data) {
3084 CXCursor *BestCursor = static_cast<CXCursor *>(client_data);
Douglas Gregor93798e22010-11-05 21:11:19 +00003085
3086 // If our current best cursor is the construction of a temporary object,
3087 // don't replace that cursor with a type reference, because we want
3088 // clang_getCursor() to point at the constructor.
3089 if (clang_isExpression(BestCursor->kind) &&
3090 isa<CXXTemporaryObjectExpr>(getCursorExpr(*BestCursor)) &&
3091 cursor.kind == CXCursor_TypeRef)
3092 return CXChildVisit_Recurse;
3093
Douglas Gregor85fe1562010-12-10 07:23:11 +00003094 // Don't override a preprocessing cursor with another preprocessing
3095 // cursor; we want the outermost preprocessing cursor.
3096 if (clang_isPreprocessing(cursor.kind) &&
3097 clang_isPreprocessing(BestCursor->kind))
3098 return CXChildVisit_Recurse;
3099
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003100 *BestCursor = cursor;
3101 return CXChildVisit_Recurse;
3102}
Ted Kremeneke68fff62010-02-17 00:41:32 +00003103
Douglas Gregorb9790342010-01-22 21:44:22 +00003104CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
3105 if (!TU)
Ted Kremenekf4629892010-01-14 01:51:23 +00003106 return clang_getNullCursor();
Ted Kremeneke68fff62010-02-17 00:41:32 +00003107
Ted Kremeneka60ed472010-11-16 08:15:36 +00003108 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregorbdf60622010-03-05 21:16:25 +00003109 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3110
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003111 // Translate the given source location to make it point at the beginning of
3112 // the token under the cursor.
Ted Kremeneka297de22010-01-25 22:34:44 +00003113 SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
Ted Kremeneka629ea42010-07-29 00:52:07 +00003114
3115 // Guard against an invalid SourceLocation, or we may assert in one
3116 // of the following calls.
3117 if (SLoc.isInvalid())
3118 return clang_getNullCursor();
3119
Douglas Gregor40749ee2010-11-03 00:35:38 +00003120 bool Logging = getenv("LIBCLANG_LOGGING");
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003121 SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
3122 CXXUnit->getASTContext().getLangOptions());
3123
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003124 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
3125 if (SLoc.isValid()) {
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003126 // FIXME: Would be great to have a "hint" cursor, then walk from that
3127 // hint cursor upward until we find a cursor whose source range encloses
3128 // the region of interest, rather than starting from the translation unit.
Ted Kremeneka60ed472010-11-16 08:15:36 +00003129 CXCursor Parent = clang_getTranslationUnitCursor(TU);
3130 CursorVisitor CursorVis(TU, GetCursorVisitor, &Result,
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003131 Decl::MaxPCHLevel, SourceLocation(SLoc));
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003132 CursorVis.VisitChildren(Parent);
Steve Naroff77128dd2009-09-15 20:25:34 +00003133 }
Douglas Gregor40749ee2010-11-03 00:35:38 +00003134
3135 if (Logging) {
3136 CXFile SearchFile;
3137 unsigned SearchLine, SearchColumn;
3138 CXFile ResultFile;
3139 unsigned ResultLine, ResultColumn;
Douglas Gregor66537982010-11-17 17:14:07 +00003140 CXString SearchFileName, ResultFileName, KindSpelling, USR;
3141 const char *IsDef = clang_isCursorDefinition(Result)? " (Definition)" : "";
Douglas Gregor40749ee2010-11-03 00:35:38 +00003142 CXSourceLocation ResultLoc = clang_getCursorLocation(Result);
3143
3144 clang_getInstantiationLocation(Loc, &SearchFile, &SearchLine, &SearchColumn,
3145 0);
3146 clang_getInstantiationLocation(ResultLoc, &ResultFile, &ResultLine,
3147 &ResultColumn, 0);
3148 SearchFileName = clang_getFileName(SearchFile);
3149 ResultFileName = clang_getFileName(ResultFile);
3150 KindSpelling = clang_getCursorKindSpelling(Result.kind);
Douglas Gregor66537982010-11-17 17:14:07 +00003151 USR = clang_getCursorUSR(Result);
3152 fprintf(stderr, "clang_getCursor(%s:%d:%d) = %s(%s:%d:%d):%s%s\n",
Douglas Gregor40749ee2010-11-03 00:35:38 +00003153 clang_getCString(SearchFileName), SearchLine, SearchColumn,
3154 clang_getCString(KindSpelling),
Douglas Gregor66537982010-11-17 17:14:07 +00003155 clang_getCString(ResultFileName), ResultLine, ResultColumn,
3156 clang_getCString(USR), IsDef);
Douglas Gregor40749ee2010-11-03 00:35:38 +00003157 clang_disposeString(SearchFileName);
3158 clang_disposeString(ResultFileName);
3159 clang_disposeString(KindSpelling);
Douglas Gregor66537982010-11-17 17:14:07 +00003160 clang_disposeString(USR);
Douglas Gregor0aefbd82010-12-10 01:45:00 +00003161
3162 CXCursor Definition = clang_getCursorDefinition(Result);
3163 if (!clang_equalCursors(Definition, clang_getNullCursor())) {
3164 CXSourceLocation DefinitionLoc = clang_getCursorLocation(Definition);
3165 CXString DefinitionKindSpelling
3166 = clang_getCursorKindSpelling(Definition.kind);
3167 CXFile DefinitionFile;
3168 unsigned DefinitionLine, DefinitionColumn;
3169 clang_getInstantiationLocation(DefinitionLoc, &DefinitionFile,
3170 &DefinitionLine, &DefinitionColumn, 0);
3171 CXString DefinitionFileName = clang_getFileName(DefinitionFile);
3172 fprintf(stderr, " -> %s(%s:%d:%d)\n",
3173 clang_getCString(DefinitionKindSpelling),
3174 clang_getCString(DefinitionFileName),
3175 DefinitionLine, DefinitionColumn);
3176 clang_disposeString(DefinitionFileName);
3177 clang_disposeString(DefinitionKindSpelling);
3178 }
Douglas Gregor40749ee2010-11-03 00:35:38 +00003179 }
3180
Ted Kremeneke68fff62010-02-17 00:41:32 +00003181 return Result;
Steve Naroff600866c2009-08-27 19:51:58 +00003182}
3183
Ted Kremenek73885552009-11-17 19:28:59 +00003184CXCursor clang_getNullCursor(void) {
Douglas Gregor5bfb8c12010-01-20 23:34:41 +00003185 return MakeCXCursorInvalid(CXCursor_InvalidFile);
Ted Kremenek73885552009-11-17 19:28:59 +00003186}
3187
3188unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
Douglas Gregor283cae32010-01-15 21:56:13 +00003189 return X == Y;
Ted Kremenek73885552009-11-17 19:28:59 +00003190}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00003191
Douglas Gregor9ce55842010-11-20 00:09:34 +00003192unsigned clang_hashCursor(CXCursor C) {
3193 unsigned Index = 0;
3194 if (clang_isExpression(C.kind) || clang_isStatement(C.kind))
3195 Index = 1;
3196
3197 return llvm::DenseMapInfo<std::pair<unsigned, void*> >::getHashValue(
3198 std::make_pair(C.kind, C.data[Index]));
3199}
3200
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003201unsigned clang_isInvalid(enum CXCursorKind K) {
Steve Naroff77128dd2009-09-15 20:25:34 +00003202 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
3203}
3204
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003205unsigned clang_isDeclaration(enum CXCursorKind K) {
Steve Naroff89922f82009-08-31 00:59:03 +00003206 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
3207}
Steve Naroff2d4d6292009-08-31 14:26:51 +00003208
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003209unsigned clang_isReference(enum CXCursorKind K) {
Steve Narofff334b4e2009-09-02 18:26:48 +00003210 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
3211}
3212
Douglas Gregor97b98722010-01-19 23:20:36 +00003213unsigned clang_isExpression(enum CXCursorKind K) {
3214 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
3215}
3216
3217unsigned clang_isStatement(enum CXCursorKind K) {
3218 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
3219}
3220
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00003221unsigned clang_isTranslationUnit(enum CXCursorKind K) {
3222 return K == CXCursor_TranslationUnit;
3223}
3224
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003225unsigned clang_isPreprocessing(enum CXCursorKind K) {
3226 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
3227}
3228
Ted Kremenekad6eff62010-03-08 21:17:29 +00003229unsigned clang_isUnexposed(enum CXCursorKind K) {
3230 switch (K) {
3231 case CXCursor_UnexposedDecl:
3232 case CXCursor_UnexposedExpr:
3233 case CXCursor_UnexposedStmt:
3234 case CXCursor_UnexposedAttr:
3235 return true;
3236 default:
3237 return false;
3238 }
3239}
3240
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003241CXCursorKind clang_getCursorKind(CXCursor C) {
Steve Naroff9efa7672009-09-04 15:44:05 +00003242 return C.kind;
3243}
3244
Douglas Gregor98258af2010-01-18 22:46:11 +00003245CXSourceLocation clang_getCursorLocation(CXCursor C) {
3246 if (clang_isReference(C.kind)) {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003247 switch (C.kind) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003248 case CXCursor_ObjCSuperClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003249 std::pair<ObjCInterfaceDecl *, SourceLocation> P
3250 = getCursorObjCSuperClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003251 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003252 }
3253
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003254 case CXCursor_ObjCProtocolRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003255 std::pair<ObjCProtocolDecl *, SourceLocation> P
3256 = getCursorObjCProtocolRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003257 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003258 }
3259
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003260 case CXCursor_ObjCClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003261 std::pair<ObjCInterfaceDecl *, SourceLocation> P
3262 = getCursorObjCClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003263 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003264 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003265
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003266 case CXCursor_TypeRef: {
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003267 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003268 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003269 }
Douglas Gregor0b36e612010-08-31 20:37:03 +00003270
3271 case CXCursor_TemplateRef: {
3272 std::pair<TemplateDecl *, SourceLocation> P = getCursorTemplateRef(C);
3273 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3274 }
3275
Douglas Gregor69319002010-08-31 23:48:11 +00003276 case CXCursor_NamespaceRef: {
3277 std::pair<NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
3278 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3279 }
3280
Douglas Gregora67e03f2010-09-09 21:42:20 +00003281 case CXCursor_MemberRef: {
3282 std::pair<FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
3283 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3284 }
3285
Ted Kremenek3064ef92010-08-27 21:34:58 +00003286 case CXCursor_CXXBaseSpecifier: {
Douglas Gregor1b0f7af2010-10-02 19:51:13 +00003287 CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C);
3288 if (!BaseSpec)
3289 return clang_getNullLocation();
3290
3291 if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo())
3292 return cxloc::translateSourceLocation(getCursorContext(C),
3293 TSInfo->getTypeLoc().getBeginLoc());
3294
3295 return cxloc::translateSourceLocation(getCursorContext(C),
3296 BaseSpec->getSourceRange().getBegin());
Ted Kremenek3064ef92010-08-27 21:34:58 +00003297 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003298
Douglas Gregor36897b02010-09-10 00:22:18 +00003299 case CXCursor_LabelRef: {
3300 std::pair<LabelStmt *, SourceLocation> P = getCursorLabelRef(C);
3301 return cxloc::translateSourceLocation(getCursorContext(C), P.second);
3302 }
3303
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003304 case CXCursor_OverloadedDeclRef:
3305 return cxloc::translateSourceLocation(getCursorContext(C),
3306 getCursorOverloadedDeclRef(C).second);
3307
Douglas Gregorf46034a2010-01-18 23:41:10 +00003308 default:
3309 // FIXME: Need a way to enumerate all non-reference cases.
3310 llvm_unreachable("Missed a reference kind");
3311 }
Douglas Gregor98258af2010-01-18 22:46:11 +00003312 }
Douglas Gregor97b98722010-01-19 23:20:36 +00003313
3314 if (clang_isExpression(C.kind))
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003315 return cxloc::translateSourceLocation(getCursorContext(C),
Douglas Gregor97b98722010-01-19 23:20:36 +00003316 getLocationFromExpr(getCursorExpr(C)));
3317
Douglas Gregor36897b02010-09-10 00:22:18 +00003318 if (clang_isStatement(C.kind))
3319 return cxloc::translateSourceLocation(getCursorContext(C),
3320 getCursorStmt(C)->getLocStart());
3321
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003322 if (C.kind == CXCursor_PreprocessingDirective) {
3323 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
3324 return cxloc::translateSourceLocation(getCursorContext(C), L);
3325 }
Douglas Gregor48072312010-03-18 15:23:44 +00003326
3327 if (C.kind == CXCursor_MacroInstantiation) {
Douglas Gregor4ae8f292010-03-18 17:52:52 +00003328 SourceLocation L
3329 = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin();
Douglas Gregor48072312010-03-18 15:23:44 +00003330 return cxloc::translateSourceLocation(getCursorContext(C), L);
3331 }
Douglas Gregor572feb22010-03-18 18:04:21 +00003332
3333 if (C.kind == CXCursor_MacroDefinition) {
3334 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
3335 return cxloc::translateSourceLocation(getCursorContext(C), L);
3336 }
Douglas Gregorecdcb882010-10-20 22:00:55 +00003337
3338 if (C.kind == CXCursor_InclusionDirective) {
3339 SourceLocation L
3340 = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin();
3341 return cxloc::translateSourceLocation(getCursorContext(C), L);
3342 }
3343
Ted Kremenek9a700d22010-05-12 06:16:13 +00003344 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
Douglas Gregor5352ac02010-01-28 00:27:43 +00003345 return clang_getNullLocation();
Douglas Gregor98258af2010-01-18 22:46:11 +00003346
Douglas Gregorf46034a2010-01-18 23:41:10 +00003347 Decl *D = getCursorDecl(C);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003348 SourceLocation Loc = D->getLocation();
3349 if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D))
3350 Loc = Class->getClassLoc();
Ted Kremenek007a7c92010-11-01 23:26:51 +00003351 // FIXME: Multiple variables declared in a single declaration
3352 // currently lack the information needed to correctly determine their
3353 // ranges when accounting for the type-specifier. We use context
3354 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3355 // and if so, whether it is the first decl.
3356 if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3357 if (!cxcursor::isFirstInDeclGroup(C))
3358 Loc = VD->getLocation();
3359 }
3360
Douglas Gregor2ca54fe2010-03-22 15:53:50 +00003361 return cxloc::translateSourceLocation(getCursorContext(C), Loc);
Douglas Gregor98258af2010-01-18 22:46:11 +00003362}
Douglas Gregora7bde202010-01-19 00:34:46 +00003363
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003364} // end extern "C"
3365
3366static SourceRange getRawCursorExtent(CXCursor C) {
Douglas Gregora7bde202010-01-19 00:34:46 +00003367 if (clang_isReference(C.kind)) {
3368 switch (C.kind) {
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003369 case CXCursor_ObjCSuperClassRef:
3370 return getCursorObjCSuperClassRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003371
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003372 case CXCursor_ObjCProtocolRef:
3373 return getCursorObjCProtocolRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003374
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003375 case CXCursor_ObjCClassRef:
3376 return getCursorObjCClassRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003377
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003378 case CXCursor_TypeRef:
3379 return getCursorTypeRef(C).second;
Douglas Gregor0b36e612010-08-31 20:37:03 +00003380
3381 case CXCursor_TemplateRef:
3382 return getCursorTemplateRef(C).second;
3383
Douglas Gregor69319002010-08-31 23:48:11 +00003384 case CXCursor_NamespaceRef:
3385 return getCursorNamespaceRef(C).second;
Douglas Gregora67e03f2010-09-09 21:42:20 +00003386
3387 case CXCursor_MemberRef:
3388 return getCursorMemberRef(C).second;
3389
Ted Kremenek3064ef92010-08-27 21:34:58 +00003390 case CXCursor_CXXBaseSpecifier:
Douglas Gregor1b0f7af2010-10-02 19:51:13 +00003391 return getCursorCXXBaseSpecifier(C)->getSourceRange();
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003392
Douglas Gregor36897b02010-09-10 00:22:18 +00003393 case CXCursor_LabelRef:
3394 return getCursorLabelRef(C).second;
3395
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003396 case CXCursor_OverloadedDeclRef:
3397 return getCursorOverloadedDeclRef(C).second;
3398
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003399 default:
3400 // FIXME: Need a way to enumerate all non-reference cases.
3401 llvm_unreachable("Missed a reference kind");
Douglas Gregora7bde202010-01-19 00:34:46 +00003402 }
3403 }
Douglas Gregor97b98722010-01-19 23:20:36 +00003404
3405 if (clang_isExpression(C.kind))
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003406 return getCursorExpr(C)->getSourceRange();
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003407
3408 if (clang_isStatement(C.kind))
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003409 return getCursorStmt(C)->getSourceRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003410
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003411 if (C.kind == CXCursor_PreprocessingDirective)
3412 return cxcursor::getCursorPreprocessingDirective(C);
Douglas Gregor48072312010-03-18 15:23:44 +00003413
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003414 if (C.kind == CXCursor_MacroInstantiation)
3415 return cxcursor::getCursorMacroInstantiation(C)->getSourceRange();
Douglas Gregor572feb22010-03-18 18:04:21 +00003416
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003417 if (C.kind == CXCursor_MacroDefinition)
3418 return cxcursor::getCursorMacroDefinition(C)->getSourceRange();
Douglas Gregorecdcb882010-10-20 22:00:55 +00003419
3420 if (C.kind == CXCursor_InclusionDirective)
3421 return cxcursor::getCursorInclusionDirective(C)->getSourceRange();
3422
Ted Kremenek007a7c92010-11-01 23:26:51 +00003423 if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl) {
3424 Decl *D = cxcursor::getCursorDecl(C);
3425 SourceRange R = D->getSourceRange();
3426 // FIXME: Multiple variables declared in a single declaration
3427 // currently lack the information needed to correctly determine their
3428 // ranges when accounting for the type-specifier. We use context
3429 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3430 // and if so, whether it is the first decl.
3431 if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3432 if (!cxcursor::isFirstInDeclGroup(C))
3433 R.setBegin(VD->getLocation());
3434 }
3435 return R;
3436 }
Douglas Gregor66537982010-11-17 17:14:07 +00003437 return SourceRange();
3438}
3439
3440/// \brief Retrieves the "raw" cursor extent, which is then extended to include
3441/// the decl-specifier-seq for declarations.
3442static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr) {
3443 if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl) {
3444 Decl *D = cxcursor::getCursorDecl(C);
3445 SourceRange R = D->getSourceRange();
3446
3447 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
3448 if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
3449 TypeLoc TL = TI->getTypeLoc();
3450 SourceLocation TLoc = TL.getSourceRange().getBegin();
3451 if (TLoc.isValid() && R.getBegin().isValid() &&
3452 SrcMgr.isBeforeInTranslationUnit(TLoc, R.getBegin()))
3453 R.setBegin(TLoc);
3454 }
3455
3456 // FIXME: Multiple variables declared in a single declaration
3457 // currently lack the information needed to correctly determine their
3458 // ranges when accounting for the type-specifier. We use context
3459 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3460 // and if so, whether it is the first decl.
3461 if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3462 if (!cxcursor::isFirstInDeclGroup(C))
3463 R.setBegin(VD->getLocation());
3464 }
3465 }
3466
3467 return R;
3468 }
3469
3470 return getRawCursorExtent(C);
3471}
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003472
3473extern "C" {
3474
3475CXSourceRange clang_getCursorExtent(CXCursor C) {
3476 SourceRange R = getRawCursorExtent(C);
3477 if (R.isInvalid())
Douglas Gregor5352ac02010-01-28 00:27:43 +00003478 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003479
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003480 return cxloc::translateSourceRange(getCursorContext(C), R);
Douglas Gregora7bde202010-01-19 00:34:46 +00003481}
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003482
3483CXCursor clang_getCursorReferenced(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003484 if (clang_isInvalid(C.kind))
3485 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003486
Ted Kremeneka60ed472010-11-16 08:15:36 +00003487 CXTranslationUnit tu = getCursorTU(C);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003488 if (clang_isDeclaration(C.kind)) {
3489 Decl *D = getCursorDecl(C);
3490 if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003491 return MakeCursorOverloadedDeclRef(Using, D->getLocation(), tu);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003492 if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003493 return MakeCursorOverloadedDeclRef(Classes, D->getLocation(), tu);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003494 if (ObjCForwardProtocolDecl *Protocols
3495 = dyn_cast<ObjCForwardProtocolDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003496 return MakeCursorOverloadedDeclRef(Protocols, D->getLocation(), tu);
Douglas Gregore3c60a72010-11-17 00:13:31 +00003497 if (ObjCPropertyImplDecl *PropImpl =llvm::dyn_cast<ObjCPropertyImplDecl>(D))
3498 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
3499 return MakeCXCursor(Property, tu);
3500
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003501 return C;
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003502 }
3503
Douglas Gregor97b98722010-01-19 23:20:36 +00003504 if (clang_isExpression(C.kind)) {
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003505 Expr *E = getCursorExpr(C);
3506 Decl *D = getDeclFromExpr(E);
Douglas Gregor97b98722010-01-19 23:20:36 +00003507 if (D)
Ted Kremeneka60ed472010-11-16 08:15:36 +00003508 return MakeCXCursor(D, tu);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003509
3510 if (OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003511 return MakeCursorOverloadedDeclRef(Ovl, tu);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003512
Douglas Gregor97b98722010-01-19 23:20:36 +00003513 return clang_getNullCursor();
3514 }
3515
Douglas Gregor36897b02010-09-10 00:22:18 +00003516 if (clang_isStatement(C.kind)) {
3517 Stmt *S = getCursorStmt(C);
3518 if (GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003519 return MakeCXCursor(Goto->getLabel(), getCursorDecl(C), tu);
Douglas Gregor36897b02010-09-10 00:22:18 +00003520
3521 return clang_getNullCursor();
3522 }
3523
Douglas Gregorbf7efa22010-03-18 18:23:03 +00003524 if (C.kind == CXCursor_MacroInstantiation) {
3525 if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003526 return MakeMacroDefinitionCursor(Def, tu);
Douglas Gregorbf7efa22010-03-18 18:23:03 +00003527 }
3528
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003529 if (!clang_isReference(C.kind))
3530 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003531
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003532 switch (C.kind) {
3533 case CXCursor_ObjCSuperClassRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003534 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, tu);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003535
3536 case CXCursor_ObjCProtocolRef: {
Ted Kremeneka60ed472010-11-16 08:15:36 +00003537 return MakeCXCursor(getCursorObjCProtocolRef(C).first, tu);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003538
3539 case CXCursor_ObjCClassRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003540 return MakeCXCursor(getCursorObjCClassRef(C).first, tu );
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003541
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003542 case CXCursor_TypeRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003543 return MakeCXCursor(getCursorTypeRef(C).first, tu );
Douglas Gregor0b36e612010-08-31 20:37:03 +00003544
3545 case CXCursor_TemplateRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003546 return MakeCXCursor(getCursorTemplateRef(C).first, tu );
Douglas Gregor0b36e612010-08-31 20:37:03 +00003547
Douglas Gregor69319002010-08-31 23:48:11 +00003548 case CXCursor_NamespaceRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003549 return MakeCXCursor(getCursorNamespaceRef(C).first, tu );
Douglas Gregor69319002010-08-31 23:48:11 +00003550
Douglas Gregora67e03f2010-09-09 21:42:20 +00003551 case CXCursor_MemberRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003552 return MakeCXCursor(getCursorMemberRef(C).first, tu );
Douglas Gregora67e03f2010-09-09 21:42:20 +00003553
Ted Kremenek3064ef92010-08-27 21:34:58 +00003554 case CXCursor_CXXBaseSpecifier: {
3555 CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
3556 return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003557 tu ));
Ted Kremenek3064ef92010-08-27 21:34:58 +00003558 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003559
Douglas Gregor36897b02010-09-10 00:22:18 +00003560 case CXCursor_LabelRef:
3561 // FIXME: We end up faking the "parent" declaration here because we
3562 // don't want to make CXCursor larger.
3563 return MakeCXCursor(getCursorLabelRef(C).first,
Ted Kremeneka60ed472010-11-16 08:15:36 +00003564 static_cast<ASTUnit*>(tu->TUData)->getASTContext()
3565 .getTranslationUnitDecl(),
3566 tu);
Douglas Gregor36897b02010-09-10 00:22:18 +00003567
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003568 case CXCursor_OverloadedDeclRef:
3569 return C;
3570
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003571 default:
3572 // We would prefer to enumerate all non-reference cursor kinds here.
3573 llvm_unreachable("Unhandled reference cursor kind");
3574 break;
3575 }
3576 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003577
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003578 return clang_getNullCursor();
3579}
3580
Douglas Gregorb6998662010-01-19 19:34:47 +00003581CXCursor clang_getCursorDefinition(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003582 if (clang_isInvalid(C.kind))
3583 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003584
Ted Kremeneka60ed472010-11-16 08:15:36 +00003585 CXTranslationUnit TU = getCursorTU(C);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003586
Douglas Gregorb6998662010-01-19 19:34:47 +00003587 bool WasReference = false;
Douglas Gregor97b98722010-01-19 23:20:36 +00003588 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
Douglas Gregorb6998662010-01-19 19:34:47 +00003589 C = clang_getCursorReferenced(C);
3590 WasReference = true;
3591 }
3592
Douglas Gregorbf7efa22010-03-18 18:23:03 +00003593 if (C.kind == CXCursor_MacroInstantiation)
3594 return clang_getCursorReferenced(C);
3595
Douglas Gregorb6998662010-01-19 19:34:47 +00003596 if (!clang_isDeclaration(C.kind))
3597 return clang_getNullCursor();
3598
3599 Decl *D = getCursorDecl(C);
3600 if (!D)
3601 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003602
Douglas Gregorb6998662010-01-19 19:34:47 +00003603 switch (D->getKind()) {
3604 // Declaration kinds that don't really separate the notions of
3605 // declaration and definition.
3606 case Decl::Namespace:
3607 case Decl::Typedef:
3608 case Decl::TemplateTypeParm:
3609 case Decl::EnumConstant:
3610 case Decl::Field:
Benjamin Kramerd9811462010-11-21 14:11:41 +00003611 case Decl::IndirectField:
Douglas Gregorb6998662010-01-19 19:34:47 +00003612 case Decl::ObjCIvar:
3613 case Decl::ObjCAtDefsField:
3614 case Decl::ImplicitParam:
3615 case Decl::ParmVar:
3616 case Decl::NonTypeTemplateParm:
3617 case Decl::TemplateTemplateParm:
3618 case Decl::ObjCCategoryImpl:
3619 case Decl::ObjCImplementation:
Abramo Bagnara6206d532010-06-05 05:09:32 +00003620 case Decl::AccessSpec:
Douglas Gregorb6998662010-01-19 19:34:47 +00003621 case Decl::LinkageSpec:
3622 case Decl::ObjCPropertyImpl:
3623 case Decl::FileScopeAsm:
3624 case Decl::StaticAssert:
3625 case Decl::Block:
3626 return C;
3627
3628 // Declaration kinds that don't make any sense here, but are
3629 // nonetheless harmless.
3630 case Decl::TranslationUnit:
Douglas Gregorb6998662010-01-19 19:34:47 +00003631 break;
3632
3633 // Declaration kinds for which the definition is not resolvable.
3634 case Decl::UnresolvedUsingTypename:
3635 case Decl::UnresolvedUsingValue:
3636 break;
3637
3638 case Decl::UsingDirective:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003639 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003640 TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003641
3642 case Decl::NamespaceAlias:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003643 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003644
3645 case Decl::Enum:
3646 case Decl::Record:
3647 case Decl::CXXRecord:
3648 case Decl::ClassTemplateSpecialization:
3649 case Decl::ClassTemplatePartialSpecialization:
Douglas Gregor952b0172010-02-11 01:04:33 +00003650 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003651 return MakeCXCursor(Def, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003652 return clang_getNullCursor();
3653
3654 case Decl::Function:
3655 case Decl::CXXMethod:
3656 case Decl::CXXConstructor:
3657 case Decl::CXXDestructor:
3658 case Decl::CXXConversion: {
3659 const FunctionDecl *Def = 0;
3660 if (cast<FunctionDecl>(D)->getBody(Def))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003661 return MakeCXCursor(const_cast<FunctionDecl *>(Def), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003662 return clang_getNullCursor();
3663 }
3664
3665 case Decl::Var: {
Sebastian Redl31310a22010-02-01 20:16:42 +00003666 // Ask the variable if it has a definition.
3667 if (VarDecl *Def = cast<VarDecl>(D)->getDefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003668 return MakeCXCursor(Def, TU);
Sebastian Redl31310a22010-02-01 20:16:42 +00003669 return clang_getNullCursor();
Douglas Gregorb6998662010-01-19 19:34:47 +00003670 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003671
Douglas Gregorb6998662010-01-19 19:34:47 +00003672 case Decl::FunctionTemplate: {
3673 const FunctionDecl *Def = 0;
3674 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003675 return MakeCXCursor(Def->getDescribedFunctionTemplate(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003676 return clang_getNullCursor();
3677 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003678
Douglas Gregorb6998662010-01-19 19:34:47 +00003679 case Decl::ClassTemplate: {
3680 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
Douglas Gregor952b0172010-02-11 01:04:33 +00003681 ->getDefinition())
Douglas Gregor0b36e612010-08-31 20:37:03 +00003682 return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003683 TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003684 return clang_getNullCursor();
3685 }
3686
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003687 case Decl::Using:
3688 return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003689 D->getLocation(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003690
3691 case Decl::UsingShadow:
3692 return clang_getCursorDefinition(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003693 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003694 TU));
Douglas Gregorb6998662010-01-19 19:34:47 +00003695
3696 case Decl::ObjCMethod: {
3697 ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
3698 if (Method->isThisDeclarationADefinition())
3699 return C;
3700
3701 // Dig out the method definition in the associated
3702 // @implementation, if we have it.
3703 // FIXME: The ASTs should make finding the definition easier.
3704 if (ObjCInterfaceDecl *Class
3705 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
3706 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
3707 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
3708 Method->isInstanceMethod()))
3709 if (Def->isThisDeclarationADefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003710 return MakeCXCursor(Def, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003711
3712 return clang_getNullCursor();
3713 }
3714
3715 case Decl::ObjCCategory:
3716 if (ObjCCategoryImplDecl *Impl
3717 = cast<ObjCCategoryDecl>(D)->getImplementation())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003718 return MakeCXCursor(Impl, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003719 return clang_getNullCursor();
3720
3721 case Decl::ObjCProtocol:
3722 if (!cast<ObjCProtocolDecl>(D)->isForwardDecl())
3723 return C;
3724 return clang_getNullCursor();
3725
3726 case Decl::ObjCInterface:
3727 // There are two notions of a "definition" for an Objective-C
3728 // class: the interface and its implementation. When we resolved a
3729 // reference to an Objective-C class, produce the @interface as
3730 // the definition; when we were provided with the interface,
3731 // produce the @implementation as the definition.
3732 if (WasReference) {
3733 if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl())
3734 return C;
3735 } else if (ObjCImplementationDecl *Impl
3736 = cast<ObjCInterfaceDecl>(D)->getImplementation())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003737 return MakeCXCursor(Impl, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003738 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003739
Douglas Gregorb6998662010-01-19 19:34:47 +00003740 case Decl::ObjCProperty:
3741 // FIXME: We don't really know where to find the
3742 // ObjCPropertyImplDecls that implement this property.
3743 return clang_getNullCursor();
3744
3745 case Decl::ObjCCompatibleAlias:
3746 if (ObjCInterfaceDecl *Class
3747 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
3748 if (!Class->isForwardDecl())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003749 return MakeCXCursor(Class, TU);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003750
Douglas Gregorb6998662010-01-19 19:34:47 +00003751 return clang_getNullCursor();
3752
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003753 case Decl::ObjCForwardProtocol:
3754 return MakeCursorOverloadedDeclRef(cast<ObjCForwardProtocolDecl>(D),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003755 D->getLocation(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003756
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003757 case Decl::ObjCClass:
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00003758 return MakeCursorOverloadedDeclRef(cast<ObjCClassDecl>(D), D->getLocation(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003759 TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003760
3761 case Decl::Friend:
3762 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003763 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
Douglas Gregorb6998662010-01-19 19:34:47 +00003764 return clang_getNullCursor();
3765
3766 case Decl::FriendTemplate:
3767 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003768 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
Douglas Gregorb6998662010-01-19 19:34:47 +00003769 return clang_getNullCursor();
3770 }
3771
3772 return clang_getNullCursor();
3773}
3774
3775unsigned clang_isCursorDefinition(CXCursor C) {
3776 if (!clang_isDeclaration(C.kind))
3777 return 0;
3778
3779 return clang_getCursorDefinition(C) == C;
3780}
3781
Douglas Gregor1a9d0502010-11-19 23:44:15 +00003782CXCursor clang_getCanonicalCursor(CXCursor C) {
3783 if (!clang_isDeclaration(C.kind))
3784 return C;
3785
3786 if (Decl *D = getCursorDecl(C))
3787 return MakeCXCursor(D->getCanonicalDecl(), getCursorTU(C));
3788
3789 return C;
3790}
3791
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003792unsigned clang_getNumOverloadedDecls(CXCursor C) {
Douglas Gregor7c432dd2010-09-16 13:54:00 +00003793 if (C.kind != CXCursor_OverloadedDeclRef)
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003794 return 0;
3795
3796 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
3797 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
3798 return E->getNumDecls();
3799
3800 if (OverloadedTemplateStorage *S
3801 = Storage.dyn_cast<OverloadedTemplateStorage*>())
3802 return S->size();
3803
3804 Decl *D = Storage.get<Decl*>();
3805 if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
Argyrios Kyrtzidis826faa22010-11-10 05:40:41 +00003806 return Using->shadow_size();
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003807 if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
3808 return Classes->size();
3809 if (ObjCForwardProtocolDecl *Protocols =dyn_cast<ObjCForwardProtocolDecl>(D))
3810 return Protocols->protocol_size();
3811
3812 return 0;
3813}
3814
3815CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) {
Douglas Gregor7c432dd2010-09-16 13:54:00 +00003816 if (cursor.kind != CXCursor_OverloadedDeclRef)
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003817 return clang_getNullCursor();
3818
3819 if (index >= clang_getNumOverloadedDecls(cursor))
3820 return clang_getNullCursor();
3821
Ted Kremeneka60ed472010-11-16 08:15:36 +00003822 CXTranslationUnit TU = getCursorTU(cursor);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003823 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first;
3824 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003825 return MakeCXCursor(E->decls_begin()[index], TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003826
3827 if (OverloadedTemplateStorage *S
3828 = Storage.dyn_cast<OverloadedTemplateStorage*>())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003829 return MakeCXCursor(S->begin()[index], TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003830
3831 Decl *D = Storage.get<Decl*>();
3832 if (UsingDecl *Using = dyn_cast<UsingDecl>(D)) {
3833 // FIXME: This is, unfortunately, linear time.
3834 UsingDecl::shadow_iterator Pos = Using->shadow_begin();
3835 std::advance(Pos, index);
Ted Kremeneka60ed472010-11-16 08:15:36 +00003836 return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003837 }
3838
3839 if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003840 return MakeCXCursor(Classes->begin()[index].getInterface(), TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003841
3842 if (ObjCForwardProtocolDecl *Protocols = dyn_cast<ObjCForwardProtocolDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003843 return MakeCXCursor(Protocols->protocol_begin()[index], TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003844
3845 return clang_getNullCursor();
3846}
3847
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00003848void clang_getDefinitionSpellingAndExtent(CXCursor C,
Steve Naroff4ade6d62009-09-23 17:52:52 +00003849 const char **startBuf,
3850 const char **endBuf,
3851 unsigned *startLine,
3852 unsigned *startColumn,
3853 unsigned *endLine,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003854 unsigned *endColumn) {
Douglas Gregor283cae32010-01-15 21:56:13 +00003855 assert(getCursorDecl(C) && "CXCursor has null decl");
3856 NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C));
Steve Naroff4ade6d62009-09-23 17:52:52 +00003857 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
3858 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003859
Steve Naroff4ade6d62009-09-23 17:52:52 +00003860 SourceManager &SM = FD->getASTContext().getSourceManager();
3861 *startBuf = SM.getCharacterData(Body->getLBracLoc());
3862 *endBuf = SM.getCharacterData(Body->getRBracLoc());
3863 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
3864 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
3865 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
3866 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
3867}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003868
Douglas Gregor0a812cf2010-02-18 23:07:20 +00003869void clang_enableStackTraces(void) {
3870 llvm::sys::PrintStackTraceOnErrorSignal();
3871}
3872
Daniel Dunbar995aaf92010-11-04 01:26:29 +00003873void clang_executeOnThread(void (*fn)(void*), void *user_data,
3874 unsigned stack_size) {
3875 llvm::llvm_execute_on_thread(fn, user_data, stack_size);
3876}
3877
Ted Kremenekfb480492010-01-13 21:46:36 +00003878} // end: extern "C"
Steve Naroff4ade6d62009-09-23 17:52:52 +00003879
Ted Kremenekfb480492010-01-13 21:46:36 +00003880//===----------------------------------------------------------------------===//
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003881// Token-based Operations.
3882//===----------------------------------------------------------------------===//
3883
3884/* CXToken layout:
3885 * int_data[0]: a CXTokenKind
3886 * int_data[1]: starting token location
3887 * int_data[2]: token length
3888 * int_data[3]: reserved
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003889 * ptr_data: for identifiers and keywords, an IdentifierInfo*.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003890 * otherwise unused.
3891 */
3892extern "C" {
3893
3894CXTokenKind clang_getTokenKind(CXToken CXTok) {
3895 return static_cast<CXTokenKind>(CXTok.int_data[0]);
3896}
3897
3898CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
3899 switch (clang_getTokenKind(CXTok)) {
3900 case CXToken_Identifier:
3901 case CXToken_Keyword:
3902 // We know we have an IdentifierInfo*, so use that.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003903 return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data)
3904 ->getNameStart());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003905
3906 case CXToken_Literal: {
3907 // We have stashed the starting pointer in the ptr_data field. Use it.
3908 const char *Text = static_cast<const char *>(CXTok.ptr_data);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003909 return createCXString(llvm::StringRef(Text, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003910 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003911
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003912 case CXToken_Punctuation:
3913 case CXToken_Comment:
3914 break;
3915 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003916
3917 // We have to find the starting buffer pointer the hard way, by
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003918 // deconstructing the source location.
Ted Kremeneka60ed472010-11-16 08:15:36 +00003919 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003920 if (!CXXUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003921 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003922
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003923 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
3924 std::pair<FileID, unsigned> LocInfo
3925 = CXXUnit->getSourceManager().getDecomposedLoc(Loc);
Douglas Gregorf715ca12010-03-16 00:06:06 +00003926 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003927 llvm::StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00003928 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
3929 if (Invalid)
Douglas Gregoraea67db2010-03-15 22:54:52 +00003930 return createCXString("");
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003931
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003932 return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003933}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003934
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003935CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
Ted Kremeneka60ed472010-11-16 08:15:36 +00003936 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003937 if (!CXXUnit)
3938 return clang_getNullLocation();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003939
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003940 return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
3941 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3942}
3943
3944CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
Ted Kremeneka60ed472010-11-16 08:15:36 +00003945 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregor5352ac02010-01-28 00:27:43 +00003946 if (!CXXUnit)
3947 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003948
3949 return cxloc::translateSourceRange(CXXUnit->getASTContext(),
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003950 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3951}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003952
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003953void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
3954 CXToken **Tokens, unsigned *NumTokens) {
3955 if (Tokens)
3956 *Tokens = 0;
3957 if (NumTokens)
3958 *NumTokens = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003959
Ted Kremeneka60ed472010-11-16 08:15:36 +00003960 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003961 if (!CXXUnit || !Tokens || !NumTokens)
3962 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003963
Douglas Gregorbdf60622010-03-05 21:16:25 +00003964 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3965
Daniel Dunbar85b988f2010-02-14 08:31:57 +00003966 SourceRange R = cxloc::translateCXSourceRange(Range);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003967 if (R.isInvalid())
3968 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003969
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003970 SourceManager &SourceMgr = CXXUnit->getSourceManager();
3971 std::pair<FileID, unsigned> BeginLocInfo
3972 = SourceMgr.getDecomposedLoc(R.getBegin());
3973 std::pair<FileID, unsigned> EndLocInfo
3974 = SourceMgr.getDecomposedLoc(R.getEnd());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003975
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003976 // Cannot tokenize across files.
3977 if (BeginLocInfo.first != EndLocInfo.first)
3978 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003979
3980 // Create a lexer
Douglas Gregorf715ca12010-03-16 00:06:06 +00003981 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003982 llvm::StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00003983 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
Douglas Gregor47a3fcd2010-03-16 20:26:15 +00003984 if (Invalid)
3985 return;
Douglas Gregoraea67db2010-03-15 22:54:52 +00003986
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003987 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
3988 CXXUnit->getASTContext().getLangOptions(),
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003989 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003990 Lex.SetCommentRetentionState(true);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003991
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003992 // Lex tokens until we hit the end of the range.
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003993 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003994 llvm::SmallVector<CXToken, 32> CXTokens;
3995 Token Tok;
David Chisnall096428b2010-10-13 21:44:48 +00003996 bool previousWasAt = false;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003997 do {
3998 // Lex the next token
3999 Lex.LexFromRawLexer(Tok);
4000 if (Tok.is(tok::eof))
4001 break;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004002
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004003 // Initialize the CXToken.
4004 CXToken CXTok;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004005
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004006 // - Common fields
4007 CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
4008 CXTok.int_data[2] = Tok.getLength();
4009 CXTok.int_data[3] = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004010
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004011 // - Kind-specific fields
4012 if (Tok.isLiteral()) {
4013 CXTok.int_data[0] = CXToken_Literal;
4014 CXTok.ptr_data = (void *)Tok.getLiteralData();
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00004015 } else if (Tok.is(tok::raw_identifier)) {
Douglas Gregoraea67db2010-03-15 22:54:52 +00004016 // Lookup the identifier to determine whether we have a keyword.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004017 IdentifierInfo *II
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00004018 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok);
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00004019
David Chisnall096428b2010-10-13 21:44:48 +00004020 if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) {
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00004021 CXTok.int_data[0] = CXToken_Keyword;
4022 }
4023 else {
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00004024 CXTok.int_data[0] = Tok.is(tok::identifier)
4025 ? CXToken_Identifier
4026 : CXToken_Keyword;
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00004027 }
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004028 CXTok.ptr_data = II;
4029 } else if (Tok.is(tok::comment)) {
4030 CXTok.int_data[0] = CXToken_Comment;
4031 CXTok.ptr_data = 0;
4032 } else {
4033 CXTok.int_data[0] = CXToken_Punctuation;
4034 CXTok.ptr_data = 0;
4035 }
4036 CXTokens.push_back(CXTok);
David Chisnall096428b2010-10-13 21:44:48 +00004037 previousWasAt = Tok.is(tok::at);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004038 } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004039
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004040 if (CXTokens.empty())
4041 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004042
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004043 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
4044 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
4045 *NumTokens = CXTokens.size();
4046}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004047
Ted Kremenek6db61092010-05-05 00:55:15 +00004048void clang_disposeTokens(CXTranslationUnit TU,
4049 CXToken *Tokens, unsigned NumTokens) {
4050 free(Tokens);
4051}
4052
4053} // end: extern "C"
4054
4055//===----------------------------------------------------------------------===//
4056// Token annotation APIs.
4057//===----------------------------------------------------------------------===//
4058
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004059typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004060static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
4061 CXCursor parent,
4062 CXClientData client_data);
Ted Kremenek6db61092010-05-05 00:55:15 +00004063namespace {
4064class AnnotateTokensWorker {
4065 AnnotateTokensData &Annotated;
Ted Kremenek11949cb2010-05-05 00:55:17 +00004066 CXToken *Tokens;
4067 CXCursor *Cursors;
4068 unsigned NumTokens;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004069 unsigned TokIdx;
Douglas Gregor4419b672010-10-21 06:10:04 +00004070 unsigned PreprocessingTokIdx;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004071 CursorVisitor AnnotateVis;
4072 SourceManager &SrcMgr;
4073
4074 bool MoreTokens() const { return TokIdx < NumTokens; }
4075 unsigned NextToken() const { return TokIdx; }
4076 void AdvanceToken() { ++TokIdx; }
4077 SourceLocation GetTokenLoc(unsigned tokI) {
4078 return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]);
4079 }
4080
Ted Kremenek6db61092010-05-05 00:55:15 +00004081public:
Ted Kremenek11949cb2010-05-05 00:55:17 +00004082 AnnotateTokensWorker(AnnotateTokensData &annotated,
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004083 CXToken *tokens, CXCursor *cursors, unsigned numTokens,
Ted Kremeneka60ed472010-11-16 08:15:36 +00004084 CXTranslationUnit tu, SourceRange RegionOfInterest)
Ted Kremenek11949cb2010-05-05 00:55:17 +00004085 : Annotated(annotated), Tokens(tokens), Cursors(cursors),
Douglas Gregor4419b672010-10-21 06:10:04 +00004086 NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004087 AnnotateVis(tu,
4088 AnnotateTokensVisitor, this,
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004089 Decl::MaxPCHLevel, RegionOfInterest),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004090 SrcMgr(static_cast<ASTUnit*>(tu->TUData)->getSourceManager()) {}
Ted Kremenek11949cb2010-05-05 00:55:17 +00004091
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004092 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
Ted Kremenek6db61092010-05-05 00:55:15 +00004093 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004094 void AnnotateTokens(CXCursor parent);
Ted Kremenekab979612010-11-11 08:05:23 +00004095 void AnnotateTokens() {
Ted Kremeneka60ed472010-11-16 08:15:36 +00004096 AnnotateTokens(clang_getTranslationUnitCursor(AnnotateVis.getTU()));
Ted Kremenekab979612010-11-11 08:05:23 +00004097 }
Ted Kremenek6db61092010-05-05 00:55:15 +00004098};
4099}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004100
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004101void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) {
4102 // Walk the AST within the region of interest, annotating tokens
4103 // along the way.
4104 VisitChildren(parent);
Ted Kremenek11949cb2010-05-05 00:55:17 +00004105
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004106 for (unsigned I = 0 ; I < TokIdx ; ++I) {
4107 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
Douglas Gregor4419b672010-10-21 06:10:04 +00004108 if (Pos != Annotated.end() &&
4109 (clang_isInvalid(Cursors[I].kind) ||
4110 Pos->second.kind != CXCursor_PreprocessingDirective))
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004111 Cursors[I] = Pos->second;
4112 }
4113
4114 // Finish up annotating any tokens left.
4115 if (!MoreTokens())
4116 return;
4117
4118 const CXCursor &C = clang_getNullCursor();
4119 for (unsigned I = TokIdx ; I < NumTokens ; ++I) {
4120 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
4121 Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second;
Ted Kremenek11949cb2010-05-05 00:55:17 +00004122 }
4123}
4124
Ted Kremenek6db61092010-05-05 00:55:15 +00004125enum CXChildVisitResult
Douglas Gregor4419b672010-10-21 06:10:04 +00004126AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004127 CXSourceLocation Loc = clang_getCursorLocation(cursor);
Douglas Gregor4419b672010-10-21 06:10:04 +00004128 SourceRange cursorRange = getRawCursorExtent(cursor);
Douglas Gregor81d3c042010-11-01 20:13:04 +00004129 if (cursorRange.isInvalid())
4130 return CXChildVisit_Recurse;
4131
Douglas Gregor4419b672010-10-21 06:10:04 +00004132 if (clang_isPreprocessing(cursor.kind)) {
4133 // For macro instantiations, just note where the beginning of the macro
4134 // instantiation occurs.
4135 if (cursor.kind == CXCursor_MacroInstantiation) {
4136 Annotated[Loc.int_data] = cursor;
4137 return CXChildVisit_Recurse;
4138 }
4139
Douglas Gregor4419b672010-10-21 06:10:04 +00004140 // Items in the preprocessing record are kept separate from items in
4141 // declarations, so we keep a separate token index.
4142 unsigned SavedTokIdx = TokIdx;
4143 TokIdx = PreprocessingTokIdx;
4144
4145 // Skip tokens up until we catch up to the beginning of the preprocessing
4146 // entry.
4147 while (MoreTokens()) {
4148 const unsigned I = NextToken();
4149 SourceLocation TokLoc = GetTokenLoc(I);
4150 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4151 case RangeBefore:
4152 AdvanceToken();
4153 continue;
4154 case RangeAfter:
4155 case RangeOverlap:
4156 break;
4157 }
4158 break;
4159 }
4160
4161 // Look at all of the tokens within this range.
4162 while (MoreTokens()) {
4163 const unsigned I = NextToken();
4164 SourceLocation TokLoc = GetTokenLoc(I);
4165 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4166 case RangeBefore:
4167 assert(0 && "Infeasible");
4168 case RangeAfter:
4169 break;
4170 case RangeOverlap:
4171 Cursors[I] = cursor;
4172 AdvanceToken();
4173 continue;
4174 }
4175 break;
4176 }
4177
4178 // Save the preprocessing token index; restore the non-preprocessing
4179 // token index.
4180 PreprocessingTokIdx = TokIdx;
4181 TokIdx = SavedTokIdx;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004182 return CXChildVisit_Recurse;
4183 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004184
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004185 if (cursorRange.isInvalid())
4186 return CXChildVisit_Continue;
Ted Kremeneka333c662010-05-12 05:29:33 +00004187
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004188 SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data);
4189
Ted Kremeneka333c662010-05-12 05:29:33 +00004190 // Adjust the annotated range based specific declarations.
4191 const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
4192 if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) {
Ted Kremenek23173d72010-05-18 21:09:07 +00004193 Decl *D = cxcursor::getCursorDecl(cursor);
4194 // Don't visit synthesized ObjC methods, since they have no syntatic
4195 // representation in the source.
4196 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
4197 if (MD->isSynthesized())
4198 return CXChildVisit_Continue;
4199 }
4200 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
Ted Kremeneka333c662010-05-12 05:29:33 +00004201 if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
4202 TypeLoc TL = TI->getTypeLoc();
Abramo Bagnarabd054db2010-05-20 10:00:11 +00004203 SourceLocation TLoc = TL.getSourceRange().getBegin();
Douglas Gregor81d3c042010-11-01 20:13:04 +00004204 if (TLoc.isValid() && L.isValid() &&
Ted Kremenek6bfd5332010-05-13 15:38:38 +00004205 SrcMgr.isBeforeInTranslationUnit(TLoc, L))
Ted Kremeneka333c662010-05-12 05:29:33 +00004206 cursorRange.setBegin(TLoc);
Ted Kremeneka333c662010-05-12 05:29:33 +00004207 }
4208 }
4209 }
Douglas Gregor81d3c042010-11-01 20:13:04 +00004210
Ted Kremenek3f404602010-08-14 01:14:06 +00004211 // If the location of the cursor occurs within a macro instantiation, record
4212 // the spelling location of the cursor in our annotation map. We can then
4213 // paper over the token labelings during a post-processing step to try and
4214 // get cursor mappings for tokens that are the *arguments* of a macro
4215 // instantiation.
4216 if (L.isMacroID()) {
4217 unsigned rawEncoding = SrcMgr.getSpellingLoc(L).getRawEncoding();
4218 // Only invalidate the old annotation if it isn't part of a preprocessing
4219 // directive. Here we assume that the default construction of CXCursor
4220 // results in CXCursor.kind being an initialized value (i.e., 0). If
4221 // this isn't the case, we can fix by doing lookup + insertion.
Douglas Gregor4419b672010-10-21 06:10:04 +00004222
Ted Kremenek3f404602010-08-14 01:14:06 +00004223 CXCursor &oldC = Annotated[rawEncoding];
4224 if (!clang_isPreprocessing(oldC.kind))
4225 oldC = cursor;
4226 }
4227
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004228 const enum CXCursorKind K = clang_getCursorKind(parent);
4229 const CXCursor updateC =
Ted Kremenekd8b0a842010-08-25 22:16:02 +00004230 (clang_isInvalid(K) || K == CXCursor_TranslationUnit)
4231 ? clang_getNullCursor() : parent;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004232
4233 while (MoreTokens()) {
4234 const unsigned I = NextToken();
4235 SourceLocation TokLoc = GetTokenLoc(I);
4236 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4237 case RangeBefore:
4238 Cursors[I] = updateC;
4239 AdvanceToken();
4240 continue;
4241 case RangeAfter:
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004242 case RangeOverlap:
4243 break;
4244 }
4245 break;
4246 }
4247
4248 // Visit children to get their cursor information.
4249 const unsigned BeforeChildren = NextToken();
4250 VisitChildren(cursor);
4251 const unsigned AfterChildren = NextToken();
4252
4253 // Adjust 'Last' to the last token within the extent of the cursor.
4254 while (MoreTokens()) {
4255 const unsigned I = NextToken();
4256 SourceLocation TokLoc = GetTokenLoc(I);
4257 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4258 case RangeBefore:
4259 assert(0 && "Infeasible");
4260 case RangeAfter:
4261 break;
4262 case RangeOverlap:
4263 Cursors[I] = updateC;
4264 AdvanceToken();
4265 continue;
4266 }
4267 break;
4268 }
4269 const unsigned Last = NextToken();
Ted Kremenek6db61092010-05-05 00:55:15 +00004270
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004271 // Scan the tokens that are at the beginning of the cursor, but are not
4272 // capture by the child cursors.
4273
4274 // For AST elements within macros, rely on a post-annotate pass to
4275 // to correctly annotate the tokens with cursors. Otherwise we can
4276 // get confusing results of having tokens that map to cursors that really
4277 // are expanded by an instantiation.
4278 if (L.isMacroID())
4279 cursor = clang_getNullCursor();
4280
4281 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
4282 if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
4283 break;
Douglas Gregor4419b672010-10-21 06:10:04 +00004284
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004285 Cursors[I] = cursor;
4286 }
4287 // Scan the tokens that are at the end of the cursor, but are not captured
4288 // but the child cursors.
4289 for (unsigned I = AfterChildren; I != Last; ++I)
4290 Cursors[I] = cursor;
4291
4292 TokIdx = Last;
4293 return CXChildVisit_Continue;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004294}
4295
Ted Kremenek6db61092010-05-05 00:55:15 +00004296static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
4297 CXCursor parent,
4298 CXClientData client_data) {
4299 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
4300}
4301
Ted Kremenekab979612010-11-11 08:05:23 +00004302// This gets run a separate thread to avoid stack blowout.
4303static void runAnnotateTokensWorker(void *UserData) {
4304 ((AnnotateTokensWorker*)UserData)->AnnotateTokens();
4305}
4306
Ted Kremenek6db61092010-05-05 00:55:15 +00004307extern "C" {
4308
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004309void clang_annotateTokens(CXTranslationUnit TU,
4310 CXToken *Tokens, unsigned NumTokens,
4311 CXCursor *Cursors) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004312
4313 if (NumTokens == 0 || !Tokens || !Cursors)
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004314 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004315
Douglas Gregor4419b672010-10-21 06:10:04 +00004316 // Any token we don't specifically annotate will have a NULL cursor.
4317 CXCursor C = clang_getNullCursor();
4318 for (unsigned I = 0; I != NumTokens; ++I)
4319 Cursors[I] = C;
4320
Ted Kremeneka60ed472010-11-16 08:15:36 +00004321 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregor4419b672010-10-21 06:10:04 +00004322 if (!CXXUnit)
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004323 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004324
Douglas Gregorbdf60622010-03-05 21:16:25 +00004325 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004326
Douglas Gregor0396f462010-03-19 05:22:59 +00004327 // Determine the region of interest, which contains all of the tokens.
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004328 SourceRange RegionOfInterest;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004329 RegionOfInterest.setBegin(cxloc::translateSourceLocation(
4330 clang_getTokenLocation(TU, Tokens[0])));
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00004331 RegionOfInterest.setEnd(cxloc::translateSourceLocation(
4332 clang_getTokenLocation(TU,
4333 Tokens[NumTokens - 1])));
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004334
Douglas Gregor0396f462010-03-19 05:22:59 +00004335 // A mapping from the source locations found when re-lexing or traversing the
4336 // region of interest to the corresponding cursors.
4337 AnnotateTokensData Annotated;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004338
4339 // Relex the tokens within the source range to look for preprocessing
Douglas Gregor0396f462010-03-19 05:22:59 +00004340 // directives.
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004341 SourceManager &SourceMgr = CXXUnit->getSourceManager();
4342 std::pair<FileID, unsigned> BeginLocInfo
4343 = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin());
4344 std::pair<FileID, unsigned> EndLocInfo
4345 = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd());
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004346
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004347 llvm::StringRef Buffer;
Douglas Gregor0396f462010-03-19 05:22:59 +00004348 bool Invalid = false;
4349 if (BeginLocInfo.first == EndLocInfo.first &&
4350 ((Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid)),true) &&
4351 !Invalid) {
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004352 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
4353 CXXUnit->getASTContext().getLangOptions(),
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004354 Buffer.begin(), Buffer.data() + BeginLocInfo.second,
Douglas Gregor4ae8f292010-03-18 17:52:52 +00004355 Buffer.end());
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004356 Lex.SetCommentRetentionState(true);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004357
4358 // Lex tokens in raw mode until we hit the end of the range, to avoid
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004359 // entering #includes or expanding macros.
Douglas Gregor48072312010-03-18 15:23:44 +00004360 while (true) {
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004361 Token Tok;
4362 Lex.LexFromRawLexer(Tok);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004363
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004364 reprocess:
4365 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
4366 // We have found a preprocessing directive. Gobble it up so that we
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00004367 // don't see it while preprocessing these tokens later, but keep track
4368 // of all of the token locations inside this preprocessing directive so
4369 // that we can annotate them appropriately.
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004370 //
4371 // FIXME: Some simple tests here could identify macro definitions and
4372 // #undefs, to provide specific cursor kinds for those.
4373 std::vector<SourceLocation> Locations;
4374 do {
4375 Locations.push_back(Tok.getLocation());
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004376 Lex.LexFromRawLexer(Tok);
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004377 } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof));
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004378
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004379 using namespace cxcursor;
4380 CXCursor Cursor
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004381 = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(),
4382 Locations.back()),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004383 TU);
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004384 for (unsigned I = 0, N = Locations.size(); I != N; ++I) {
4385 Annotated[Locations[I].getRawEncoding()] = Cursor;
4386 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004387
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004388 if (Tok.isAtStartOfLine())
4389 goto reprocess;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004390
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004391 continue;
4392 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004393
Douglas Gregor48072312010-03-18 15:23:44 +00004394 if (Tok.is(tok::eof))
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004395 break;
4396 }
Douglas Gregor4ae8f292010-03-18 17:52:52 +00004397 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004398
Douglas Gregor0396f462010-03-19 05:22:59 +00004399 // Annotate all of the source locations in the region of interest that map to
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004400 // a specific cursor.
4401 AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens,
Ted Kremeneka60ed472010-11-16 08:15:36 +00004402 TU, RegionOfInterest);
Ted Kremenekab979612010-11-11 08:05:23 +00004403
4404 // Run the worker within a CrashRecoveryContext.
Ted Kremenek6c53fdd2010-11-14 17:47:35 +00004405 // FIXME: We use a ridiculous stack size here because the data-recursion
4406 // algorithm uses a large stack frame than the non-data recursive version,
4407 // and AnnotationTokensWorker currently transforms the data-recursion
4408 // algorithm back into a traditional recursion by explicitly calling
4409 // VisitChildren(). We will need to remove this explicit recursive call.
Ted Kremenekab979612010-11-11 08:05:23 +00004410 llvm::CrashRecoveryContext CRC;
Ted Kremenek6c53fdd2010-11-14 17:47:35 +00004411 if (!RunSafely(CRC, runAnnotateTokensWorker, &W,
4412 GetSafetyThreadStackSize() * 2)) {
Ted Kremenekab979612010-11-11 08:05:23 +00004413 fprintf(stderr, "libclang: crash detected while annotating tokens\n");
4414 }
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004415}
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004416} // end: extern "C"
4417
4418//===----------------------------------------------------------------------===//
Ted Kremenek16b42592010-03-03 06:36:57 +00004419// Operations for querying linkage of a cursor.
4420//===----------------------------------------------------------------------===//
4421
4422extern "C" {
4423CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
Douglas Gregor0396f462010-03-19 05:22:59 +00004424 if (!clang_isDeclaration(cursor.kind))
4425 return CXLinkage_Invalid;
4426
Ted Kremenek16b42592010-03-03 06:36:57 +00004427 Decl *D = cxcursor::getCursorDecl(cursor);
4428 if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
4429 switch (ND->getLinkage()) {
4430 case NoLinkage: return CXLinkage_NoLinkage;
4431 case InternalLinkage: return CXLinkage_Internal;
4432 case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
4433 case ExternalLinkage: return CXLinkage_External;
4434 };
4435
4436 return CXLinkage_Invalid;
4437}
4438} // end: extern "C"
4439
4440//===----------------------------------------------------------------------===//
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004441// Operations for querying language of a cursor.
4442//===----------------------------------------------------------------------===//
4443
4444static CXLanguageKind getDeclLanguage(const Decl *D) {
4445 switch (D->getKind()) {
4446 default:
4447 break;
4448 case Decl::ImplicitParam:
4449 case Decl::ObjCAtDefsField:
4450 case Decl::ObjCCategory:
4451 case Decl::ObjCCategoryImpl:
4452 case Decl::ObjCClass:
4453 case Decl::ObjCCompatibleAlias:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004454 case Decl::ObjCForwardProtocol:
4455 case Decl::ObjCImplementation:
4456 case Decl::ObjCInterface:
4457 case Decl::ObjCIvar:
4458 case Decl::ObjCMethod:
4459 case Decl::ObjCProperty:
4460 case Decl::ObjCPropertyImpl:
4461 case Decl::ObjCProtocol:
4462 return CXLanguage_ObjC;
4463 case Decl::CXXConstructor:
4464 case Decl::CXXConversion:
4465 case Decl::CXXDestructor:
4466 case Decl::CXXMethod:
4467 case Decl::CXXRecord:
4468 case Decl::ClassTemplate:
4469 case Decl::ClassTemplatePartialSpecialization:
4470 case Decl::ClassTemplateSpecialization:
4471 case Decl::Friend:
4472 case Decl::FriendTemplate:
4473 case Decl::FunctionTemplate:
4474 case Decl::LinkageSpec:
4475 case Decl::Namespace:
4476 case Decl::NamespaceAlias:
4477 case Decl::NonTypeTemplateParm:
4478 case Decl::StaticAssert:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004479 case Decl::TemplateTemplateParm:
4480 case Decl::TemplateTypeParm:
4481 case Decl::UnresolvedUsingTypename:
4482 case Decl::UnresolvedUsingValue:
4483 case Decl::Using:
4484 case Decl::UsingDirective:
4485 case Decl::UsingShadow:
4486 return CXLanguage_CPlusPlus;
4487 }
4488
4489 return CXLanguage_C;
4490}
4491
4492extern "C" {
Douglas Gregor58ddb602010-08-23 23:00:57 +00004493
4494enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
4495 if (clang_isDeclaration(cursor.kind))
4496 if (Decl *D = cxcursor::getCursorDecl(cursor)) {
4497 if (D->hasAttr<UnavailableAttr>() ||
4498 (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted()))
4499 return CXAvailability_Available;
4500
4501 if (D->hasAttr<DeprecatedAttr>())
4502 return CXAvailability_Deprecated;
4503 }
4504
4505 return CXAvailability_Available;
4506}
4507
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004508CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
4509 if (clang_isDeclaration(cursor.kind))
4510 return getDeclLanguage(cxcursor::getCursorDecl(cursor));
4511
4512 return CXLanguage_Invalid;
4513}
Douglas Gregor3910cfd2010-12-21 07:55:45 +00004514
4515 /// \brief If the given cursor is the "templated" declaration
4516 /// descibing a class or function template, return the class or
4517 /// function template.
4518static Decl *maybeGetTemplateCursor(Decl *D) {
4519 if (!D)
4520 return 0;
4521
4522 if (FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
4523 if (FunctionTemplateDecl *FunTmpl = FD->getDescribedFunctionTemplate())
4524 return FunTmpl;
4525
4526 if (CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D))
4527 if (ClassTemplateDecl *ClassTmpl = RD->getDescribedClassTemplate())
4528 return ClassTmpl;
4529
4530 return D;
4531}
4532
Douglas Gregor2be5bc92010-09-22 21:22:29 +00004533CXCursor clang_getCursorSemanticParent(CXCursor cursor) {
4534 if (clang_isDeclaration(cursor.kind)) {
4535 if (Decl *D = getCursorDecl(cursor)) {
4536 DeclContext *DC = D->getDeclContext();
Douglas Gregor3910cfd2010-12-21 07:55:45 +00004537 if (!DC)
4538 return clang_getNullCursor();
4539
4540 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
4541 getCursorTU(cursor));
Douglas Gregor2be5bc92010-09-22 21:22:29 +00004542 }
4543 }
4544
4545 if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) {
4546 if (Decl *D = getCursorDecl(cursor))
Ted Kremeneka60ed472010-11-16 08:15:36 +00004547 return MakeCXCursor(D, getCursorTU(cursor));
Douglas Gregor2be5bc92010-09-22 21:22:29 +00004548 }
4549
4550 return clang_getNullCursor();
4551}
4552
4553CXCursor clang_getCursorLexicalParent(CXCursor cursor) {
4554 if (clang_isDeclaration(cursor.kind)) {
4555 if (Decl *D = getCursorDecl(cursor)) {
4556 DeclContext *DC = D->getLexicalDeclContext();
Douglas Gregor3910cfd2010-12-21 07:55:45 +00004557 if (!DC)
4558 return clang_getNullCursor();
4559
4560 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
4561 getCursorTU(cursor));
Douglas Gregor2be5bc92010-09-22 21:22:29 +00004562 }
4563 }
4564
4565 // FIXME: Note that we can't easily compute the lexical context of a
4566 // statement or expression, so we return nothing.
4567 return clang_getNullCursor();
4568}
4569
Douglas Gregor9f592342010-10-01 20:25:15 +00004570static void CollectOverriddenMethods(DeclContext *Ctx,
4571 ObjCMethodDecl *Method,
4572 llvm::SmallVectorImpl<ObjCMethodDecl *> &Methods) {
4573 if (!Ctx)
4574 return;
4575
4576 // If we have a class or category implementation, jump straight to the
4577 // interface.
4578 if (ObjCImplDecl *Impl = dyn_cast<ObjCImplDecl>(Ctx))
4579 return CollectOverriddenMethods(Impl->getClassInterface(), Method, Methods);
4580
4581 ObjCContainerDecl *Container = dyn_cast<ObjCContainerDecl>(Ctx);
4582 if (!Container)
4583 return;
4584
4585 // Check whether we have a matching method at this level.
4586 if (ObjCMethodDecl *Overridden = Container->getMethod(Method->getSelector(),
4587 Method->isInstanceMethod()))
4588 if (Method != Overridden) {
4589 // We found an override at this level; there is no need to look
4590 // into other protocols or categories.
4591 Methods.push_back(Overridden);
4592 return;
4593 }
4594
4595 if (ObjCProtocolDecl *Protocol = dyn_cast<ObjCProtocolDecl>(Container)) {
4596 for (ObjCProtocolDecl::protocol_iterator P = Protocol->protocol_begin(),
4597 PEnd = Protocol->protocol_end();
4598 P != PEnd; ++P)
4599 CollectOverriddenMethods(*P, Method, Methods);
4600 }
4601
4602 if (ObjCCategoryDecl *Category = dyn_cast<ObjCCategoryDecl>(Container)) {
4603 for (ObjCCategoryDecl::protocol_iterator P = Category->protocol_begin(),
4604 PEnd = Category->protocol_end();
4605 P != PEnd; ++P)
4606 CollectOverriddenMethods(*P, Method, Methods);
4607 }
4608
4609 if (ObjCInterfaceDecl *Interface = dyn_cast<ObjCInterfaceDecl>(Container)) {
4610 for (ObjCInterfaceDecl::protocol_iterator P = Interface->protocol_begin(),
4611 PEnd = Interface->protocol_end();
4612 P != PEnd; ++P)
4613 CollectOverriddenMethods(*P, Method, Methods);
4614
4615 for (ObjCCategoryDecl *Category = Interface->getCategoryList();
4616 Category; Category = Category->getNextClassCategory())
4617 CollectOverriddenMethods(Category, Method, Methods);
4618
4619 // We only look into the superclass if we haven't found anything yet.
4620 if (Methods.empty())
4621 if (ObjCInterfaceDecl *Super = Interface->getSuperClass())
4622 return CollectOverriddenMethods(Super, Method, Methods);
4623 }
4624}
4625
4626void clang_getOverriddenCursors(CXCursor cursor,
4627 CXCursor **overridden,
4628 unsigned *num_overridden) {
4629 if (overridden)
4630 *overridden = 0;
4631 if (num_overridden)
4632 *num_overridden = 0;
4633 if (!overridden || !num_overridden)
4634 return;
4635
4636 if (!clang_isDeclaration(cursor.kind))
4637 return;
4638
4639 Decl *D = getCursorDecl(cursor);
4640 if (!D)
4641 return;
4642
4643 // Handle C++ member functions.
Ted Kremeneka60ed472010-11-16 08:15:36 +00004644 CXTranslationUnit TU = getCursorTU(cursor);
Douglas Gregor9f592342010-10-01 20:25:15 +00004645 if (CXXMethodDecl *CXXMethod = dyn_cast<CXXMethodDecl>(D)) {
4646 *num_overridden = CXXMethod->size_overridden_methods();
4647 if (!*num_overridden)
4648 return;
4649
4650 *overridden = new CXCursor [*num_overridden];
4651 unsigned I = 0;
4652 for (CXXMethodDecl::method_iterator
4653 M = CXXMethod->begin_overridden_methods(),
4654 MEnd = CXXMethod->end_overridden_methods();
4655 M != MEnd; (void)++M, ++I)
Ted Kremeneka60ed472010-11-16 08:15:36 +00004656 (*overridden)[I] = MakeCXCursor(const_cast<CXXMethodDecl*>(*M), TU);
Douglas Gregor9f592342010-10-01 20:25:15 +00004657 return;
4658 }
4659
4660 ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D);
4661 if (!Method)
4662 return;
4663
4664 // Handle Objective-C methods.
4665 llvm::SmallVector<ObjCMethodDecl *, 4> Methods;
4666 CollectOverriddenMethods(Method->getDeclContext(), Method, Methods);
4667
4668 if (Methods.empty())
4669 return;
4670
4671 *num_overridden = Methods.size();
4672 *overridden = new CXCursor [Methods.size()];
4673 for (unsigned I = 0, N = Methods.size(); I != N; ++I)
Ted Kremeneka60ed472010-11-16 08:15:36 +00004674 (*overridden)[I] = MakeCXCursor(Methods[I], TU);
Douglas Gregor9f592342010-10-01 20:25:15 +00004675}
4676
4677void clang_disposeOverriddenCursors(CXCursor *overridden) {
4678 delete [] overridden;
4679}
4680
Douglas Gregorecdcb882010-10-20 22:00:55 +00004681CXFile clang_getIncludedFile(CXCursor cursor) {
4682 if (cursor.kind != CXCursor_InclusionDirective)
4683 return 0;
4684
4685 InclusionDirective *ID = getCursorInclusionDirective(cursor);
4686 return (void *)ID->getFile();
4687}
4688
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004689} // end: extern "C"
4690
Ted Kremenek9ada39a2010-05-17 20:06:56 +00004691
4692//===----------------------------------------------------------------------===//
4693// C++ AST instrospection.
4694//===----------------------------------------------------------------------===//
4695
4696extern "C" {
4697unsigned clang_CXXMethod_isStatic(CXCursor C) {
4698 if (!clang_isDeclaration(C.kind))
4699 return 0;
Douglas Gregor49f6f542010-08-31 22:12:17 +00004700
4701 CXXMethodDecl *Method = 0;
4702 Decl *D = cxcursor::getCursorDecl(C);
4703 if (FunctionTemplateDecl *FunTmpl = dyn_cast_or_null<FunctionTemplateDecl>(D))
4704 Method = dyn_cast<CXXMethodDecl>(FunTmpl->getTemplatedDecl());
4705 else
4706 Method = dyn_cast_or_null<CXXMethodDecl>(D);
4707 return (Method && Method->isStatic()) ? 1 : 0;
Ted Kremenek40b492a2010-05-17 20:12:45 +00004708}
Ted Kremenekb12903e2010-05-18 22:32:15 +00004709
Ted Kremenek9ada39a2010-05-17 20:06:56 +00004710} // end: extern "C"
4711
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004712//===----------------------------------------------------------------------===//
Ted Kremenek95f33552010-08-26 01:42:22 +00004713// Attribute introspection.
4714//===----------------------------------------------------------------------===//
4715
4716extern "C" {
4717CXType clang_getIBOutletCollectionType(CXCursor C) {
4718 if (C.kind != CXCursor_IBOutletCollectionAttr)
Ted Kremeneka60ed472010-11-16 08:15:36 +00004719 return cxtype::MakeCXType(QualType(), cxcursor::getCursorTU(C));
Ted Kremenek95f33552010-08-26 01:42:22 +00004720
4721 IBOutletCollectionAttr *A =
4722 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
4723
Ted Kremeneka60ed472010-11-16 08:15:36 +00004724 return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorTU(C));
Ted Kremenek95f33552010-08-26 01:42:22 +00004725}
4726} // end: extern "C"
4727
4728//===----------------------------------------------------------------------===//
Ted Kremenek04bb7162010-01-22 22:44:15 +00004729// Misc. utility functions.
4730//===----------------------------------------------------------------------===//
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004731
Daniel Dunbarabdce7a2010-11-05 17:21:46 +00004732/// Default to using an 8 MB stack size on "safety" threads.
4733static unsigned SafetyStackThreadSize = 8 << 20;
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00004734
4735namespace clang {
4736
4737bool RunSafely(llvm::CrashRecoveryContext &CRC,
Ted Kremenek6c53fdd2010-11-14 17:47:35 +00004738 void (*Fn)(void*), void *UserData,
4739 unsigned Size) {
4740 if (!Size)
4741 Size = GetSafetyThreadStackSize();
4742 if (Size)
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00004743 return CRC.RunSafelyOnThread(Fn, UserData, Size);
4744 return CRC.RunSafely(Fn, UserData);
4745}
4746
4747unsigned GetSafetyThreadStackSize() {
4748 return SafetyStackThreadSize;
4749}
4750
4751void SetSafetyThreadStackSize(unsigned Value) {
4752 SafetyStackThreadSize = Value;
4753}
4754
4755}
4756
Ted Kremenek04bb7162010-01-22 22:44:15 +00004757extern "C" {
4758
Ted Kremeneka2a9d6e2010-02-12 22:54:40 +00004759CXString clang_getClangVersion() {
Ted Kremenekee4db4f2010-02-17 00:41:08 +00004760 return createCXString(getClangFullVersion());
Ted Kremenek04bb7162010-01-22 22:44:15 +00004761}
4762
4763} // end: extern "C"