blob: 574b4c8b4efb016a6d2877b1f424a4516fb306f1 [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.
Sean Huntcbb67482011-01-08 20:30:50 +0000692static int CompareCXXCtorInitializers(const void* Xp, const void *Yp) {
693 CXXCtorInitializer const * const *X
694 = static_cast<CXXCtorInitializer const * const *>(Xp);
695 CXXCtorInitializer const * const *Y
696 = static_cast<CXXCtorInitializer const * const *>(Yp);
Douglas Gregora67e03f2010-09-09 21:42:20 +0000697
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.
Sean Huntcbb67482011-01-08 20:30:50 +0000741 llvm::SmallVector<CXXCtorInitializer *, 4> WrittenInits;
Douglas Gregora67e03f2010-09-09 21:42:20 +0000742 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(),
Sean Huntcbb67482011-01-08 20:30:50 +0000753 &CompareCXXCtorInitializers);
Douglas Gregora67e03f2010-09-09 21:42:20 +0000754
755 // Visit the initializers in source order
756 for (unsigned I = 0, N = WrittenInits.size(); I != N; ++I) {
Sean Huntcbb67482011-01-08 20:30:50 +0000757 CXXCtorInitializer *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 Gregora7fc9012011-01-05 18:58:31 +00001259 case TemplateArgument::TemplateExpansion:
1260 return VisitTemplateName(TAL.getArgument().getAsTemplateOrTemplatePattern(),
Douglas Gregor0b36e612010-08-31 20:37:03 +00001261 TAL.getTemplateNameLoc());
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001262 }
1263
1264 return false;
1265}
1266
Ted Kremeneka0536d82010-05-07 01:04:29 +00001267bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
1268 return VisitDeclContext(D);
1269}
1270
Douglas Gregor01829d32010-08-31 14:41:23 +00001271bool CursorVisitor::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
1272 return Visit(TL.getUnqualifiedLoc());
1273}
1274
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001275bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Ted Kremeneka60ed472010-11-16 08:15:36 +00001276 ASTContext &Context = AU->getASTContext();
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001277
1278 // Some builtin types (such as Objective-C's "id", "sel", and
1279 // "Class") have associated declarations. Create cursors for those.
1280 QualType VisitType;
1281 switch (TL.getType()->getAs<BuiltinType>()->getKind()) {
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001282 case BuiltinType::Void:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001283 case BuiltinType::Bool:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001284 case BuiltinType::Char_U:
1285 case BuiltinType::UChar:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001286 case BuiltinType::Char16:
1287 case BuiltinType::Char32:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001288 case BuiltinType::UShort:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001289 case BuiltinType::UInt:
1290 case BuiltinType::ULong:
1291 case BuiltinType::ULongLong:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001292 case BuiltinType::UInt128:
1293 case BuiltinType::Char_S:
1294 case BuiltinType::SChar:
Chris Lattner3f59c972010-12-25 23:25:43 +00001295 case BuiltinType::WChar_U:
1296 case BuiltinType::WChar_S:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001297 case BuiltinType::Short:
1298 case BuiltinType::Int:
1299 case BuiltinType::Long:
1300 case BuiltinType::LongLong:
1301 case BuiltinType::Int128:
1302 case BuiltinType::Float:
1303 case BuiltinType::Double:
1304 case BuiltinType::LongDouble:
1305 case BuiltinType::NullPtr:
1306 case BuiltinType::Overload:
1307 case BuiltinType::Dependent:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001308 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001309
1310 case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor?
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001311 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001312
Ted Kremenekc4174cc2010-02-18 18:52:18 +00001313 case BuiltinType::ObjCId:
1314 VisitType = Context.getObjCIdType();
1315 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001316
1317 case BuiltinType::ObjCClass:
1318 VisitType = Context.getObjCClassType();
1319 break;
1320
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001321 case BuiltinType::ObjCSel:
1322 VisitType = Context.getObjCSelType();
1323 break;
1324 }
1325
1326 if (!VisitType.isNull()) {
1327 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001328 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001329 TU));
1330 }
1331
1332 return false;
1333}
1334
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001335bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
1336 return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU));
1337}
1338
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001339bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
1340 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1341}
1342
1343bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
1344 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1345}
1346
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001347bool CursorVisitor::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00001348 // FIXME: We can't visit the template type parameter, because there's
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001349 // no context information with which we can match up the depth/index in the
1350 // type to the appropriate
1351 return false;
1352}
1353
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001354bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
1355 if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU)))
1356 return true;
1357
John McCallc12c5bb2010-05-15 11:32:37 +00001358 return false;
1359}
1360
1361bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
1362 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
1363 return true;
1364
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001365 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1366 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1367 TU)))
1368 return true;
1369 }
1370
1371 return false;
1372}
1373
1374bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
John McCallc12c5bb2010-05-15 11:32:37 +00001375 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001376}
1377
Abramo Bagnara075f8f12010-12-10 16:29:40 +00001378bool CursorVisitor::VisitParenTypeLoc(ParenTypeLoc TL) {
1379 return Visit(TL.getInnerLoc());
1380}
1381
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001382bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
1383 return Visit(TL.getPointeeLoc());
1384}
1385
1386bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
1387 return Visit(TL.getPointeeLoc());
1388}
1389
1390bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
1391 return Visit(TL.getPointeeLoc());
1392}
1393
1394bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001395 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001396}
1397
1398bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001399 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001400}
1401
Douglas Gregor01829d32010-08-31 14:41:23 +00001402bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL,
1403 bool SkipResultType) {
1404 if (!SkipResultType && Visit(TL.getResultLoc()))
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001405 return true;
1406
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001407 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
Ted Kremenek5dbacb42010-04-07 00:27:13 +00001408 if (Decl *D = TL.getArg(I))
1409 if (Visit(MakeCXCursor(D, TU)))
1410 return true;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001411
1412 return false;
1413}
1414
1415bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
1416 if (Visit(TL.getElementLoc()))
1417 return true;
1418
1419 if (Expr *Size = TL.getSizeExpr())
1420 return Visit(MakeCXCursor(Size, StmtParent, TU));
1421
1422 return false;
1423}
1424
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001425bool CursorVisitor::VisitTemplateSpecializationTypeLoc(
1426 TemplateSpecializationTypeLoc TL) {
Douglas Gregor0b36e612010-08-31 20:37:03 +00001427 // Visit the template name.
1428 if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1429 TL.getTemplateNameLoc()))
1430 return true;
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001431
1432 // Visit the template arguments.
1433 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1434 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1435 return true;
1436
1437 return false;
1438}
1439
Douglas Gregor2332c112010-01-21 20:48:56 +00001440bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
1441 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
1442}
1443
1444bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
1445 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1446 return Visit(TSInfo->getTypeLoc());
1447
1448 return false;
1449}
1450
Douglas Gregor7536dd52010-12-20 02:24:11 +00001451bool CursorVisitor::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
1452 return Visit(TL.getPatternLoc());
1453}
1454
Ted Kremenek3064ef92010-08-27 21:34:58 +00001455bool CursorVisitor::VisitCXXRecordDecl(CXXRecordDecl *D) {
1456 if (D->isDefinition()) {
1457 for (CXXRecordDecl::base_class_iterator I = D->bases_begin(),
1458 E = D->bases_end(); I != E; ++I) {
1459 if (Visit(cxcursor::MakeCursorCXXBaseSpecifier(I, TU)))
1460 return true;
1461 }
1462 }
1463
1464 return VisitTagDecl(D);
1465}
1466
Ted Kremenek09dfa372010-02-18 05:46:33 +00001467bool CursorVisitor::VisitAttributes(Decl *D) {
Sean Huntcf807c42010-08-18 23:23:40 +00001468 for (AttrVec::const_iterator i = D->attr_begin(), e = D->attr_end();
1469 i != e; ++i)
1470 if (Visit(MakeCXCursor(*i, D, TU)))
Ted Kremenek09dfa372010-02-18 05:46:33 +00001471 return true;
1472
1473 return false;
1474}
1475
Ted Kremenekc0e1d922010-11-11 08:05:18 +00001476//===----------------------------------------------------------------------===//
1477// Data-recursive visitor methods.
1478//===----------------------------------------------------------------------===//
1479
Ted Kremenek28a71942010-11-13 00:36:47 +00001480namespace {
Ted Kremenek035dc412010-11-13 00:36:50 +00001481#define DEF_JOB(NAME, DATA, KIND)\
1482class NAME : public VisitorJob {\
1483public:\
1484 NAME(DATA *d, CXCursor parent) : VisitorJob(parent, VisitorJob::KIND, d) {} \
1485 static bool classof(const VisitorJob *VJ) { return VJ->getKind() == KIND; }\
Ted Kremenekf64d8032010-11-18 00:02:32 +00001486 DATA *get() const { return static_cast<DATA*>(data[0]); }\
Ted Kremenek035dc412010-11-13 00:36:50 +00001487};
1488
1489DEF_JOB(StmtVisit, Stmt, StmtVisitKind)
1490DEF_JOB(MemberExprParts, MemberExpr, MemberExprPartsKind)
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001491DEF_JOB(DeclRefExprParts, DeclRefExpr, DeclRefExprPartsKind)
Ted Kremenek035dc412010-11-13 00:36:50 +00001492DEF_JOB(OverloadExprParts, OverloadExpr, OverloadExprPartsKind)
Ted Kremenek60608ec2010-11-17 00:50:47 +00001493DEF_JOB(ExplicitTemplateArgsVisit, ExplicitTemplateArgumentList,
1494 ExplicitTemplateArgsVisitKind)
Ted Kremenek035dc412010-11-13 00:36:50 +00001495#undef DEF_JOB
1496
1497class DeclVisit : public VisitorJob {
1498public:
1499 DeclVisit(Decl *d, CXCursor parent, bool isFirst) :
1500 VisitorJob(parent, VisitorJob::DeclVisitKind,
1501 d, isFirst ? (void*) 1 : (void*) 0) {}
1502 static bool classof(const VisitorJob *VJ) {
Ted Kremenek82f3c502010-11-15 22:23:26 +00001503 return VJ->getKind() == DeclVisitKind;
Ted Kremenek035dc412010-11-13 00:36:50 +00001504 }
Ted Kremenekf64d8032010-11-18 00:02:32 +00001505 Decl *get() const { return static_cast<Decl*>(data[0]); }
1506 bool isFirst() const { return data[1] ? true : false; }
Ted Kremenek035dc412010-11-13 00:36:50 +00001507};
Ted Kremenek035dc412010-11-13 00:36:50 +00001508class TypeLocVisit : public VisitorJob {
1509public:
1510 TypeLocVisit(TypeLoc tl, CXCursor parent) :
1511 VisitorJob(parent, VisitorJob::TypeLocVisitKind,
1512 tl.getType().getAsOpaquePtr(), tl.getOpaqueData()) {}
1513
1514 static bool classof(const VisitorJob *VJ) {
1515 return VJ->getKind() == TypeLocVisitKind;
1516 }
1517
Ted Kremenek82f3c502010-11-15 22:23:26 +00001518 TypeLoc get() const {
Ted Kremenekf64d8032010-11-18 00:02:32 +00001519 QualType T = QualType::getFromOpaquePtr(data[0]);
1520 return TypeLoc(T, data[1]);
Ted Kremenek035dc412010-11-13 00:36:50 +00001521 }
1522};
1523
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001524class LabelRefVisit : public VisitorJob {
1525public:
1526 LabelRefVisit(LabelStmt *LS, SourceLocation labelLoc, CXCursor parent)
1527 : VisitorJob(parent, VisitorJob::LabelRefVisitKind, LS,
1528 (void*) labelLoc.getRawEncoding()) {}
1529
1530 static bool classof(const VisitorJob *VJ) {
1531 return VJ->getKind() == VisitorJob::LabelRefVisitKind;
1532 }
Ted Kremenekf64d8032010-11-18 00:02:32 +00001533 LabelStmt *get() const { return static_cast<LabelStmt*>(data[0]); }
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001534 SourceLocation getLoc() const {
Ted Kremenekf64d8032010-11-18 00:02:32 +00001535 return SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]); }
1536};
1537class NestedNameSpecifierVisit : public VisitorJob {
1538public:
1539 NestedNameSpecifierVisit(NestedNameSpecifier *NS, SourceRange R,
1540 CXCursor parent)
1541 : VisitorJob(parent, VisitorJob::NestedNameSpecifierVisitKind,
1542 NS, (void*) R.getBegin().getRawEncoding(),
1543 (void*) R.getEnd().getRawEncoding()) {}
1544 static bool classof(const VisitorJob *VJ) {
1545 return VJ->getKind() == VisitorJob::NestedNameSpecifierVisitKind;
1546 }
1547 NestedNameSpecifier *get() const {
1548 return static_cast<NestedNameSpecifier*>(data[0]);
1549 }
1550 SourceRange getSourceRange() const {
1551 SourceLocation A =
1552 SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]);
1553 SourceLocation B =
1554 SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[2]);
1555 return SourceRange(A, B);
1556 }
1557};
1558class DeclarationNameInfoVisit : public VisitorJob {
1559public:
1560 DeclarationNameInfoVisit(Stmt *S, CXCursor parent)
1561 : VisitorJob(parent, VisitorJob::DeclarationNameInfoVisitKind, S) {}
1562 static bool classof(const VisitorJob *VJ) {
1563 return VJ->getKind() == VisitorJob::DeclarationNameInfoVisitKind;
1564 }
1565 DeclarationNameInfo get() const {
1566 Stmt *S = static_cast<Stmt*>(data[0]);
1567 switch (S->getStmtClass()) {
1568 default:
1569 llvm_unreachable("Unhandled Stmt");
1570 case Stmt::CXXDependentScopeMemberExprClass:
1571 return cast<CXXDependentScopeMemberExpr>(S)->getMemberNameInfo();
1572 case Stmt::DependentScopeDeclRefExprClass:
1573 return cast<DependentScopeDeclRefExpr>(S)->getNameInfo();
1574 }
1575 }
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001576};
Ted Kremenekcdba6592010-11-18 00:42:18 +00001577class MemberRefVisit : public VisitorJob {
1578public:
1579 MemberRefVisit(FieldDecl *D, SourceLocation L, CXCursor parent)
1580 : VisitorJob(parent, VisitorJob::MemberRefVisitKind, D,
1581 (void*) L.getRawEncoding()) {}
1582 static bool classof(const VisitorJob *VJ) {
1583 return VJ->getKind() == VisitorJob::MemberRefVisitKind;
1584 }
1585 FieldDecl *get() const {
1586 return static_cast<FieldDecl*>(data[0]);
1587 }
1588 SourceLocation getLoc() const {
1589 return SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]);
1590 }
1591};
Ted Kremenek28a71942010-11-13 00:36:47 +00001592class EnqueueVisitor : public StmtVisitor<EnqueueVisitor, void> {
1593 VisitorWorkList &WL;
1594 CXCursor Parent;
1595public:
1596 EnqueueVisitor(VisitorWorkList &wl, CXCursor parent)
1597 : WL(wl), Parent(parent) {}
1598
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001599 void VisitAddrLabelExpr(AddrLabelExpr *E);
Ted Kremenek73d15c42010-11-13 01:09:29 +00001600 void VisitBlockExpr(BlockExpr *B);
Ted Kremenek28a71942010-11-13 00:36:47 +00001601 void VisitCompoundLiteralExpr(CompoundLiteralExpr *E);
Ted Kremenek083c7e22010-11-13 05:38:03 +00001602 void VisitCompoundStmt(CompoundStmt *S);
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001603 void VisitCXXDefaultArgExpr(CXXDefaultArgExpr *E) { /* Do nothing. */ }
Ted Kremenekf64d8032010-11-18 00:02:32 +00001604 void VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E);
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001605 void VisitCXXNewExpr(CXXNewExpr *E);
Ted Kremenek6d0a00d2010-11-17 02:18:35 +00001606 void VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001607 void VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001608 void VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E);
Ted Kremenek73d15c42010-11-13 01:09:29 +00001609 void VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E);
Ted Kremenekb8dd1ca2010-11-17 00:50:41 +00001610 void VisitCXXTypeidExpr(CXXTypeidExpr *E);
Ted Kremenek55b933a2010-11-17 00:50:36 +00001611 void VisitCXXUnresolvedConstructExpr(CXXUnresolvedConstructExpr *E);
Ted Kremenek1e7e8772010-11-17 00:50:52 +00001612 void VisitCXXUuidofExpr(CXXUuidofExpr *E);
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001613 void VisitDeclRefExpr(DeclRefExpr *D);
Ted Kremenek035dc412010-11-13 00:36:50 +00001614 void VisitDeclStmt(DeclStmt *S);
Ted Kremenekf64d8032010-11-18 00:02:32 +00001615 void VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001616 void VisitDesignatedInitExpr(DesignatedInitExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001617 void VisitExplicitCastExpr(ExplicitCastExpr *E);
1618 void VisitForStmt(ForStmt *FS);
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001619 void VisitGotoStmt(GotoStmt *GS);
Ted Kremenek28a71942010-11-13 00:36:47 +00001620 void VisitIfStmt(IfStmt *If);
1621 void VisitInitListExpr(InitListExpr *IE);
1622 void VisitMemberExpr(MemberExpr *M);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001623 void VisitOffsetOfExpr(OffsetOfExpr *E);
Ted Kremenek73d15c42010-11-13 01:09:29 +00001624 void VisitObjCEncodeExpr(ObjCEncodeExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001625 void VisitObjCMessageExpr(ObjCMessageExpr *M);
1626 void VisitOverloadExpr(OverloadExpr *E);
Ted Kremenek6d0a00d2010-11-17 02:18:35 +00001627 void VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001628 void VisitStmt(Stmt *S);
1629 void VisitSwitchStmt(SwitchStmt *S);
1630 void VisitWhileStmt(WhileStmt *W);
Ted Kremenek2939b6f2010-11-17 00:50:50 +00001631 void VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E);
Francois Pichet6ad6f282010-12-07 00:08:36 +00001632 void VisitBinaryTypeTraitExpr(BinaryTypeTraitExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001633 void VisitUnresolvedMemberExpr(UnresolvedMemberExpr *U);
Ted Kremenek9d3bf792010-11-17 00:50:43 +00001634 void VisitVAArgExpr(VAArgExpr *E);
Douglas Gregoree8aff02011-01-04 17:33:58 +00001635 // FIXME: Variadic templates SizeOfPackExpr!
1636
Ted Kremenek28a71942010-11-13 00:36:47 +00001637private:
Ted Kremenekf64d8032010-11-18 00:02:32 +00001638 void AddDeclarationNameInfo(Stmt *S);
1639 void AddNestedNameSpecifier(NestedNameSpecifier *NS, SourceRange R);
Ted Kremenek60608ec2010-11-17 00:50:47 +00001640 void AddExplicitTemplateArgs(const ExplicitTemplateArgumentList *A);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001641 void AddMemberRef(FieldDecl *D, SourceLocation L);
Ted Kremenek28a71942010-11-13 00:36:47 +00001642 void AddStmt(Stmt *S);
Ted Kremenek035dc412010-11-13 00:36:50 +00001643 void AddDecl(Decl *D, bool isFirst = true);
Ted Kremenek28a71942010-11-13 00:36:47 +00001644 void AddTypeLoc(TypeSourceInfo *TI);
1645 void EnqueueChildren(Stmt *S);
1646};
1647} // end anonyous namespace
1648
Ted Kremenekf64d8032010-11-18 00:02:32 +00001649void EnqueueVisitor::AddDeclarationNameInfo(Stmt *S) {
1650 // 'S' should always be non-null, since it comes from the
1651 // statement we are visiting.
1652 WL.push_back(DeclarationNameInfoVisit(S, Parent));
1653}
1654void EnqueueVisitor::AddNestedNameSpecifier(NestedNameSpecifier *N,
1655 SourceRange R) {
1656 if (N)
1657 WL.push_back(NestedNameSpecifierVisit(N, R, Parent));
1658}
Ted Kremenek28a71942010-11-13 00:36:47 +00001659void EnqueueVisitor::AddStmt(Stmt *S) {
1660 if (S)
1661 WL.push_back(StmtVisit(S, Parent));
1662}
Ted Kremenek035dc412010-11-13 00:36:50 +00001663void EnqueueVisitor::AddDecl(Decl *D, bool isFirst) {
Ted Kremenek28a71942010-11-13 00:36:47 +00001664 if (D)
Ted Kremenek035dc412010-11-13 00:36:50 +00001665 WL.push_back(DeclVisit(D, Parent, isFirst));
Ted Kremenek28a71942010-11-13 00:36:47 +00001666}
Ted Kremenek60608ec2010-11-17 00:50:47 +00001667void EnqueueVisitor::
1668 AddExplicitTemplateArgs(const ExplicitTemplateArgumentList *A) {
1669 if (A)
1670 WL.push_back(ExplicitTemplateArgsVisit(
1671 const_cast<ExplicitTemplateArgumentList*>(A), Parent));
1672}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001673void EnqueueVisitor::AddMemberRef(FieldDecl *D, SourceLocation L) {
1674 if (D)
1675 WL.push_back(MemberRefVisit(D, L, Parent));
1676}
Ted Kremenek28a71942010-11-13 00:36:47 +00001677void EnqueueVisitor::AddTypeLoc(TypeSourceInfo *TI) {
1678 if (TI)
1679 WL.push_back(TypeLocVisit(TI->getTypeLoc(), Parent));
1680 }
1681void EnqueueVisitor::EnqueueChildren(Stmt *S) {
Ted Kremeneka6b70432010-11-12 21:34:09 +00001682 unsigned size = WL.size();
1683 for (Stmt::child_iterator Child = S->child_begin(), ChildEnd = S->child_end();
1684 Child != ChildEnd; ++Child) {
Ted Kremenek28a71942010-11-13 00:36:47 +00001685 AddStmt(*Child);
Ted Kremeneka6b70432010-11-12 21:34:09 +00001686 }
1687 if (size == WL.size())
1688 return;
1689 // Now reverse the entries we just added. This will match the DFS
1690 // ordering performed by the worklist.
1691 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
1692 std::reverse(I, E);
1693}
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001694void EnqueueVisitor::VisitAddrLabelExpr(AddrLabelExpr *E) {
1695 WL.push_back(LabelRefVisit(E->getLabel(), E->getLabelLoc(), Parent));
1696}
Ted Kremenek73d15c42010-11-13 01:09:29 +00001697void EnqueueVisitor::VisitBlockExpr(BlockExpr *B) {
1698 AddDecl(B->getBlockDecl());
1699}
Ted Kremenek28a71942010-11-13 00:36:47 +00001700void EnqueueVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) {
1701 EnqueueChildren(E);
1702 AddTypeLoc(E->getTypeSourceInfo());
1703}
Ted Kremenek083c7e22010-11-13 05:38:03 +00001704void EnqueueVisitor::VisitCompoundStmt(CompoundStmt *S) {
1705 for (CompoundStmt::reverse_body_iterator I = S->body_rbegin(),
1706 E = S->body_rend(); I != E; ++I) {
1707 AddStmt(*I);
1708 }
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001709}
Ted Kremenekf64d8032010-11-18 00:02:32 +00001710void EnqueueVisitor::
1711VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E) {
1712 AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
1713 AddDeclarationNameInfo(E);
1714 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1715 AddNestedNameSpecifier(Qualifier, E->getQualifierRange());
1716 if (!E->isImplicitAccess())
1717 AddStmt(E->getBase());
1718}
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001719void EnqueueVisitor::VisitCXXNewExpr(CXXNewExpr *E) {
1720 // Enqueue the initializer or constructor arguments.
1721 for (unsigned I = E->getNumConstructorArgs(); I > 0; --I)
1722 AddStmt(E->getConstructorArg(I-1));
1723 // Enqueue the array size, if any.
1724 AddStmt(E->getArraySize());
1725 // Enqueue the allocated type.
1726 AddTypeLoc(E->getAllocatedTypeSourceInfo());
1727 // Enqueue the placement arguments.
1728 for (unsigned I = E->getNumPlacementArgs(); I > 0; --I)
1729 AddStmt(E->getPlacementArg(I-1));
1730}
Ted Kremenek28a71942010-11-13 00:36:47 +00001731void EnqueueVisitor::VisitCXXOperatorCallExpr(CXXOperatorCallExpr *CE) {
Ted Kremenek8b8d8c92010-11-13 05:55:56 +00001732 for (unsigned I = CE->getNumArgs(); I > 1 /* Yes, this is 1 */; --I)
1733 AddStmt(CE->getArg(I-1));
Ted Kremenek28a71942010-11-13 00:36:47 +00001734 AddStmt(CE->getCallee());
1735 AddStmt(CE->getArg(0));
1736}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001737void EnqueueVisitor::VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E) {
1738 // Visit the name of the type being destroyed.
1739 AddTypeLoc(E->getDestroyedTypeInfo());
1740 // Visit the scope type that looks disturbingly like the nested-name-specifier
1741 // but isn't.
1742 AddTypeLoc(E->getScopeTypeInfo());
1743 // Visit the nested-name-specifier.
1744 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1745 AddNestedNameSpecifier(Qualifier, E->getQualifierRange());
1746 // Visit base expression.
1747 AddStmt(E->getBase());
1748}
Ted Kremenek6d0a00d2010-11-17 02:18:35 +00001749void EnqueueVisitor::VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E) {
1750 AddTypeLoc(E->getTypeSourceInfo());
1751}
Ted Kremenek73d15c42010-11-13 01:09:29 +00001752void EnqueueVisitor::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E) {
1753 EnqueueChildren(E);
1754 AddTypeLoc(E->getTypeSourceInfo());
1755}
Ted Kremenekb8dd1ca2010-11-17 00:50:41 +00001756void EnqueueVisitor::VisitCXXTypeidExpr(CXXTypeidExpr *E) {
1757 EnqueueChildren(E);
1758 if (E->isTypeOperand())
1759 AddTypeLoc(E->getTypeOperandSourceInfo());
1760}
Ted Kremenek55b933a2010-11-17 00:50:36 +00001761
1762void EnqueueVisitor::VisitCXXUnresolvedConstructExpr(CXXUnresolvedConstructExpr
1763 *E) {
1764 EnqueueChildren(E);
1765 AddTypeLoc(E->getTypeSourceInfo());
1766}
Ted Kremenek1e7e8772010-11-17 00:50:52 +00001767void EnqueueVisitor::VisitCXXUuidofExpr(CXXUuidofExpr *E) {
1768 EnqueueChildren(E);
1769 if (E->isTypeOperand())
1770 AddTypeLoc(E->getTypeOperandSourceInfo());
1771}
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001772void EnqueueVisitor::VisitDeclRefExpr(DeclRefExpr *DR) {
Ted Kremenek60608ec2010-11-17 00:50:47 +00001773 if (DR->hasExplicitTemplateArgs()) {
1774 AddExplicitTemplateArgs(&DR->getExplicitTemplateArgs());
1775 }
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001776 WL.push_back(DeclRefExprParts(DR, Parent));
1777}
Ted Kremenekf64d8032010-11-18 00:02:32 +00001778void EnqueueVisitor::VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E) {
1779 AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
1780 AddDeclarationNameInfo(E);
1781 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1782 AddNestedNameSpecifier(Qualifier, E->getQualifierRange());
1783}
Ted Kremenek035dc412010-11-13 00:36:50 +00001784void EnqueueVisitor::VisitDeclStmt(DeclStmt *S) {
1785 unsigned size = WL.size();
1786 bool isFirst = true;
1787 for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end();
1788 D != DEnd; ++D) {
1789 AddDecl(*D, isFirst);
1790 isFirst = false;
1791 }
1792 if (size == WL.size())
1793 return;
1794 // Now reverse the entries we just added. This will match the DFS
1795 // ordering performed by the worklist.
1796 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
1797 std::reverse(I, E);
1798}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001799void EnqueueVisitor::VisitDesignatedInitExpr(DesignatedInitExpr *E) {
1800 AddStmt(E->getInit());
1801 typedef DesignatedInitExpr::Designator Designator;
1802 for (DesignatedInitExpr::reverse_designators_iterator
1803 D = E->designators_rbegin(), DEnd = E->designators_rend();
1804 D != DEnd; ++D) {
1805 if (D->isFieldDesignator()) {
1806 if (FieldDecl *Field = D->getField())
1807 AddMemberRef(Field, D->getFieldLoc());
1808 continue;
1809 }
1810 if (D->isArrayDesignator()) {
1811 AddStmt(E->getArrayIndex(*D));
1812 continue;
1813 }
1814 assert(D->isArrayRangeDesignator() && "Unknown designator kind");
1815 AddStmt(E->getArrayRangeEnd(*D));
1816 AddStmt(E->getArrayRangeStart(*D));
1817 }
1818}
Ted Kremenek28a71942010-11-13 00:36:47 +00001819void EnqueueVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) {
1820 EnqueueChildren(E);
1821 AddTypeLoc(E->getTypeInfoAsWritten());
1822}
1823void EnqueueVisitor::VisitForStmt(ForStmt *FS) {
1824 AddStmt(FS->getBody());
1825 AddStmt(FS->getInc());
1826 AddStmt(FS->getCond());
1827 AddDecl(FS->getConditionVariable());
1828 AddStmt(FS->getInit());
1829}
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001830void EnqueueVisitor::VisitGotoStmt(GotoStmt *GS) {
1831 WL.push_back(LabelRefVisit(GS->getLabel(), GS->getLabelLoc(), Parent));
1832}
Ted Kremenek28a71942010-11-13 00:36:47 +00001833void EnqueueVisitor::VisitIfStmt(IfStmt *If) {
1834 AddStmt(If->getElse());
1835 AddStmt(If->getThen());
1836 AddStmt(If->getCond());
1837 AddDecl(If->getConditionVariable());
1838}
1839void EnqueueVisitor::VisitInitListExpr(InitListExpr *IE) {
1840 // We care about the syntactic form of the initializer list, only.
1841 if (InitListExpr *Syntactic = IE->getSyntacticForm())
1842 IE = Syntactic;
1843 EnqueueChildren(IE);
1844}
1845void EnqueueVisitor::VisitMemberExpr(MemberExpr *M) {
Douglas Gregor89629a72010-11-17 17:15:08 +00001846 WL.push_back(MemberExprParts(M, Parent));
1847
1848 // If the base of the member access expression is an implicit 'this', don't
1849 // visit it.
1850 // FIXME: If we ever want to show these implicit accesses, this will be
1851 // unfortunate. However, clang_getCursor() relies on this behavior.
1852 if (CXXThisExpr *This
1853 = llvm::dyn_cast<CXXThisExpr>(M->getBase()->IgnoreParenImpCasts()))
1854 if (This->isImplicit())
1855 return;
1856
Ted Kremenek28a71942010-11-13 00:36:47 +00001857 AddStmt(M->getBase());
1858}
Ted Kremenek73d15c42010-11-13 01:09:29 +00001859void EnqueueVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) {
1860 AddTypeLoc(E->getEncodedTypeSourceInfo());
1861}
Ted Kremenek28a71942010-11-13 00:36:47 +00001862void EnqueueVisitor::VisitObjCMessageExpr(ObjCMessageExpr *M) {
1863 EnqueueChildren(M);
1864 AddTypeLoc(M->getClassReceiverTypeInfo());
1865}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001866void EnqueueVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) {
1867 // Visit the components of the offsetof expression.
1868 for (unsigned N = E->getNumComponents(), I = N; I > 0; --I) {
1869 typedef OffsetOfExpr::OffsetOfNode OffsetOfNode;
1870 const OffsetOfNode &Node = E->getComponent(I-1);
1871 switch (Node.getKind()) {
1872 case OffsetOfNode::Array:
1873 AddStmt(E->getIndexExpr(Node.getArrayExprIndex()));
1874 break;
1875 case OffsetOfNode::Field:
1876 AddMemberRef(Node.getField(), Node.getRange().getEnd());
1877 break;
1878 case OffsetOfNode::Identifier:
1879 case OffsetOfNode::Base:
1880 continue;
1881 }
1882 }
1883 // Visit the type into which we're computing the offset.
1884 AddTypeLoc(E->getTypeSourceInfo());
1885}
Ted Kremenek28a71942010-11-13 00:36:47 +00001886void EnqueueVisitor::VisitOverloadExpr(OverloadExpr *E) {
Ted Kremenek60608ec2010-11-17 00:50:47 +00001887 AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
Ted Kremenek60458782010-11-12 21:34:16 +00001888 WL.push_back(OverloadExprParts(E, Parent));
1889}
Ted Kremenek6d0a00d2010-11-17 02:18:35 +00001890void EnqueueVisitor::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E) {
1891 EnqueueChildren(E);
1892 if (E->isArgumentType())
1893 AddTypeLoc(E->getArgumentTypeInfo());
1894}
Ted Kremenek28a71942010-11-13 00:36:47 +00001895void EnqueueVisitor::VisitStmt(Stmt *S) {
1896 EnqueueChildren(S);
1897}
1898void EnqueueVisitor::VisitSwitchStmt(SwitchStmt *S) {
1899 AddStmt(S->getBody());
1900 AddStmt(S->getCond());
1901 AddDecl(S->getConditionVariable());
1902}
Ted Kremenekfafa75a2010-11-17 00:50:39 +00001903
Ted Kremenek28a71942010-11-13 00:36:47 +00001904void EnqueueVisitor::VisitWhileStmt(WhileStmt *W) {
1905 AddStmt(W->getBody());
1906 AddStmt(W->getCond());
1907 AddDecl(W->getConditionVariable());
1908}
Ted Kremenek2939b6f2010-11-17 00:50:50 +00001909void EnqueueVisitor::VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E) {
1910 AddTypeLoc(E->getQueriedTypeSourceInfo());
1911}
Francois Pichet6ad6f282010-12-07 00:08:36 +00001912
1913void EnqueueVisitor::VisitBinaryTypeTraitExpr(BinaryTypeTraitExpr *E) {
Francois Pichet6ad6f282010-12-07 00:08:36 +00001914 AddTypeLoc(E->getRhsTypeSourceInfo());
Francois Pichet0a03a3f2010-12-08 09:11:05 +00001915 AddTypeLoc(E->getLhsTypeSourceInfo());
Francois Pichet6ad6f282010-12-07 00:08:36 +00001916}
1917
Ted Kremenek28a71942010-11-13 00:36:47 +00001918void EnqueueVisitor::VisitUnresolvedMemberExpr(UnresolvedMemberExpr *U) {
1919 VisitOverloadExpr(U);
1920 if (!U->isImplicitAccess())
1921 AddStmt(U->getBase());
1922}
Ted Kremenek9d3bf792010-11-17 00:50:43 +00001923void EnqueueVisitor::VisitVAArgExpr(VAArgExpr *E) {
1924 AddStmt(E->getSubExpr());
1925 AddTypeLoc(E->getWrittenTypeInfo());
1926}
Ted Kremenek60458782010-11-12 21:34:16 +00001927
Ted Kremenekc0e1d922010-11-11 08:05:18 +00001928void CursorVisitor::EnqueueWorkList(VisitorWorkList &WL, Stmt *S) {
Ted Kremenek28a71942010-11-13 00:36:47 +00001929 EnqueueVisitor(WL, MakeCXCursor(S, StmtParent, TU)).Visit(S);
Ted Kremenekc0e1d922010-11-11 08:05:18 +00001930}
1931
1932bool CursorVisitor::IsInRegionOfInterest(CXCursor C) {
1933 if (RegionOfInterest.isValid()) {
1934 SourceRange Range = getRawCursorExtent(C);
1935 if (Range.isInvalid() || CompareRegionOfInterest(Range))
1936 return false;
1937 }
1938 return true;
1939}
1940
1941bool CursorVisitor::RunVisitorWorkList(VisitorWorkList &WL) {
1942 while (!WL.empty()) {
1943 // Dequeue the worklist item.
Ted Kremenek82f3c502010-11-15 22:23:26 +00001944 VisitorJob LI = WL.back();
1945 WL.pop_back();
1946
Ted Kremenekc0e1d922010-11-11 08:05:18 +00001947 // Set the Parent field, then back to its old value once we're done.
1948 SetParentRAII SetParent(Parent, StmtParent, LI.getParent());
1949
1950 switch (LI.getKind()) {
Ted Kremenekf1107452010-11-12 18:26:56 +00001951 case VisitorJob::DeclVisitKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00001952 Decl *D = cast<DeclVisit>(&LI)->get();
Ted Kremenekf1107452010-11-12 18:26:56 +00001953 if (!D)
1954 continue;
1955
1956 // For now, perform default visitation for Decls.
Ted Kremenek82f3c502010-11-15 22:23:26 +00001957 if (Visit(MakeCXCursor(D, TU, cast<DeclVisit>(&LI)->isFirst())))
Ted Kremenekf1107452010-11-12 18:26:56 +00001958 return true;
1959
1960 continue;
1961 }
Ted Kremenek60608ec2010-11-17 00:50:47 +00001962 case VisitorJob::ExplicitTemplateArgsVisitKind: {
1963 const ExplicitTemplateArgumentList *ArgList =
1964 cast<ExplicitTemplateArgsVisit>(&LI)->get();
1965 for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1966 *ArgEnd = Arg + ArgList->NumTemplateArgs;
1967 Arg != ArgEnd; ++Arg) {
1968 if (VisitTemplateArgumentLoc(*Arg))
1969 return true;
1970 }
1971 continue;
1972 }
Ted Kremenekcdb4caf2010-11-12 21:34:12 +00001973 case VisitorJob::TypeLocVisitKind: {
1974 // Perform default visitation for TypeLocs.
Ted Kremenek82f3c502010-11-15 22:23:26 +00001975 if (Visit(cast<TypeLocVisit>(&LI)->get()))
Ted Kremenekcdb4caf2010-11-12 21:34:12 +00001976 return true;
1977 continue;
1978 }
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001979 case VisitorJob::LabelRefVisitKind: {
1980 LabelStmt *LS = cast<LabelRefVisit>(&LI)->get();
1981 if (Visit(MakeCursorLabelRef(LS,
1982 cast<LabelRefVisit>(&LI)->getLoc(),
1983 TU)))
1984 return true;
1985 continue;
1986 }
Ted Kremenekf64d8032010-11-18 00:02:32 +00001987 case VisitorJob::NestedNameSpecifierVisitKind: {
1988 NestedNameSpecifierVisit *V = cast<NestedNameSpecifierVisit>(&LI);
1989 if (VisitNestedNameSpecifier(V->get(), V->getSourceRange()))
1990 return true;
1991 continue;
1992 }
1993 case VisitorJob::DeclarationNameInfoVisitKind: {
1994 if (VisitDeclarationNameInfo(cast<DeclarationNameInfoVisit>(&LI)
1995 ->get()))
1996 return true;
1997 continue;
1998 }
Ted Kremenekcdba6592010-11-18 00:42:18 +00001999 case VisitorJob::MemberRefVisitKind: {
2000 MemberRefVisit *V = cast<MemberRefVisit>(&LI);
2001 if (Visit(MakeCursorMemberRef(V->get(), V->getLoc(), TU)))
2002 return true;
2003 continue;
2004 }
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002005 case VisitorJob::StmtVisitKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00002006 Stmt *S = cast<StmtVisit>(&LI)->get();
Ted Kremenek8c269ac2010-11-11 23:11:43 +00002007 if (!S)
2008 continue;
2009
Ted Kremenekf1107452010-11-12 18:26:56 +00002010 // Update the current cursor.
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002011 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU);
Ted Kremenekcdba6592010-11-18 00:42:18 +00002012 if (!IsInRegionOfInterest(Cursor))
2013 continue;
2014 switch (Visitor(Cursor, Parent, ClientData)) {
2015 case CXChildVisit_Break: return true;
2016 case CXChildVisit_Continue: break;
2017 case CXChildVisit_Recurse:
2018 EnqueueWorkList(WL, S);
Ted Kremenek82f3c502010-11-15 22:23:26 +00002019 break;
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002020 }
Ted Kremenek82f3c502010-11-15 22:23:26 +00002021 continue;
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002022 }
2023 case VisitorJob::MemberExprPartsKind: {
2024 // Handle the other pieces in the MemberExpr besides the base.
Ted Kremenek82f3c502010-11-15 22:23:26 +00002025 MemberExpr *M = cast<MemberExprParts>(&LI)->get();
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002026
2027 // Visit the nested-name-specifier
2028 if (NestedNameSpecifier *Qualifier = M->getQualifier())
2029 if (VisitNestedNameSpecifier(Qualifier, M->getQualifierRange()))
2030 return true;
2031
2032 // Visit the declaration name.
2033 if (VisitDeclarationNameInfo(M->getMemberNameInfo()))
2034 return true;
2035
2036 // Visit the explicitly-specified template arguments, if any.
2037 if (M->hasExplicitTemplateArgs()) {
2038 for (const TemplateArgumentLoc *Arg = M->getTemplateArgs(),
2039 *ArgEnd = Arg + M->getNumTemplateArgs();
2040 Arg != ArgEnd; ++Arg) {
2041 if (VisitTemplateArgumentLoc(*Arg))
2042 return true;
2043 }
2044 }
2045 continue;
2046 }
Ted Kremeneke4979cc2010-11-13 00:58:18 +00002047 case VisitorJob::DeclRefExprPartsKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00002048 DeclRefExpr *DR = cast<DeclRefExprParts>(&LI)->get();
Ted Kremeneke4979cc2010-11-13 00:58:18 +00002049 // Visit nested-name-specifier, if present.
2050 if (NestedNameSpecifier *Qualifier = DR->getQualifier())
2051 if (VisitNestedNameSpecifier(Qualifier, DR->getQualifierRange()))
2052 return true;
2053 // Visit declaration name.
2054 if (VisitDeclarationNameInfo(DR->getNameInfo()))
2055 return true;
Ted Kremeneke4979cc2010-11-13 00:58:18 +00002056 continue;
2057 }
Ted Kremenek60458782010-11-12 21:34:16 +00002058 case VisitorJob::OverloadExprPartsKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00002059 OverloadExpr *O = cast<OverloadExprParts>(&LI)->get();
Ted Kremenek60458782010-11-12 21:34:16 +00002060 // Visit the nested-name-specifier.
2061 if (NestedNameSpecifier *Qualifier = O->getQualifier())
2062 if (VisitNestedNameSpecifier(Qualifier, O->getQualifierRange()))
2063 return true;
2064 // Visit the declaration name.
2065 if (VisitDeclarationNameInfo(O->getNameInfo()))
2066 return true;
2067 // Visit the overloaded declaration reference.
2068 if (Visit(MakeCursorOverloadedDeclRef(O, TU)))
2069 return true;
Ted Kremenek60458782010-11-12 21:34:16 +00002070 continue;
2071 }
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002072 }
2073 }
2074 return false;
2075}
2076
Ted Kremenekcdba6592010-11-18 00:42:18 +00002077bool CursorVisitor::Visit(Stmt *S) {
Ted Kremenekd1ded662010-11-15 23:31:32 +00002078 VisitorWorkList *WL = 0;
2079 if (!WorkListFreeList.empty()) {
2080 WL = WorkListFreeList.back();
2081 WL->clear();
2082 WorkListFreeList.pop_back();
2083 }
2084 else {
2085 WL = new VisitorWorkList();
2086 WorkListCache.push_back(WL);
2087 }
2088 EnqueueWorkList(*WL, S);
2089 bool result = RunVisitorWorkList(*WL);
2090 WorkListFreeList.push_back(WL);
2091 return result;
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002092}
2093
2094//===----------------------------------------------------------------------===//
2095// Misc. API hooks.
2096//===----------------------------------------------------------------------===//
2097
Douglas Gregor8c8d5412010-09-24 21:18:36 +00002098static llvm::sys::Mutex EnableMultithreadingMutex;
2099static bool EnabledMultithreading;
2100
Benjamin Kramer5e4bc592009-10-18 16:11:04 +00002101extern "C" {
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002102CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
2103 int displayDiagnostics) {
Daniel Dunbar48615ff2010-10-08 19:30:33 +00002104 // Disable pretty stack trace functionality, which will otherwise be a very
2105 // poor citizen of the world and set up all sorts of signal handlers.
2106 llvm::DisablePrettyStackTrace = true;
2107
Daniel Dunbarc7df4f32010-08-18 18:43:14 +00002108 // We use crash recovery to make some of our APIs more reliable, implicitly
2109 // enable it.
2110 llvm::CrashRecoveryContext::Enable();
2111
Douglas Gregor8c8d5412010-09-24 21:18:36 +00002112 // Enable support for multithreading in LLVM.
2113 {
2114 llvm::sys::ScopedLock L(EnableMultithreadingMutex);
2115 if (!EnabledMultithreading) {
2116 llvm::llvm_start_multithreaded();
2117 EnabledMultithreading = true;
2118 }
2119 }
2120
Douglas Gregora030b7c2010-01-22 20:35:53 +00002121 CIndexer *CIdxr = new CIndexer();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002122 if (excludeDeclarationsFromPCH)
2123 CIdxr->setOnlyLocalDecls();
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002124 if (displayDiagnostics)
2125 CIdxr->setDisplayDiagnostics();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002126 return CIdxr;
Steve Naroff600866c2009-08-27 19:51:58 +00002127}
2128
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002129void clang_disposeIndex(CXIndex CIdx) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002130 if (CIdx)
2131 delete static_cast<CIndexer *>(CIdx);
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00002132}
2133
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002134CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
Douglas Gregora88084b2010-02-18 18:08:43 +00002135 const char *ast_filename) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002136 if (!CIdx)
2137 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002138
Douglas Gregor7d1d49d2009-10-16 20:01:17 +00002139 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +00002140 FileSystemOptions FileSystemOpts;
2141 FileSystemOpts.WorkingDir = CXXIdx->getWorkingDirectory();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002142
Douglas Gregor28019772010-04-05 23:52:57 +00002143 llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
Ted Kremeneka60ed472010-11-16 08:15:36 +00002144 ASTUnit *TU = ASTUnit::LoadFromASTFile(ast_filename, Diags, FileSystemOpts,
Douglas Gregora88084b2010-02-18 18:08:43 +00002145 CXXIdx->getOnlyLocalDecls(),
2146 0, 0, true);
Ted Kremeneka60ed472010-11-16 08:15:36 +00002147 return MakeCXTranslationUnit(TU);
Steve Naroff600866c2009-08-27 19:51:58 +00002148}
2149
Douglas Gregorb1c031b2010-08-09 22:28:58 +00002150unsigned clang_defaultEditingTranslationUnitOptions() {
Douglas Gregor2a2c50b2010-09-27 05:49:58 +00002151 return CXTranslationUnit_PrecompiledPreamble |
Douglas Gregor99ba2022010-10-27 17:24:53 +00002152 CXTranslationUnit_CacheCompletionResults |
2153 CXTranslationUnit_CXXPrecompiledPreamble;
Douglas Gregorb1c031b2010-08-09 22:28:58 +00002154}
2155
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002156CXTranslationUnit
2157clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
2158 const char *source_filename,
2159 int num_command_line_args,
Douglas Gregor2ef69442010-09-01 16:43:19 +00002160 const char * const *command_line_args,
Douglas Gregor4db64a42010-01-23 00:14:00 +00002161 unsigned num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +00002162 struct CXUnsavedFile *unsaved_files) {
Douglas Gregor5a430212010-07-21 18:52:53 +00002163 return clang_parseTranslationUnit(CIdx, source_filename,
2164 command_line_args, num_command_line_args,
2165 unsaved_files, num_unsaved_files,
2166 CXTranslationUnit_DetailedPreprocessingRecord);
2167}
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002168
2169struct ParseTranslationUnitInfo {
2170 CXIndex CIdx;
2171 const char *source_filename;
Douglas Gregor2ef69442010-09-01 16:43:19 +00002172 const char *const *command_line_args;
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002173 int num_command_line_args;
2174 struct CXUnsavedFile *unsaved_files;
2175 unsigned num_unsaved_files;
2176 unsigned options;
2177 CXTranslationUnit result;
2178};
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00002179static void clang_parseTranslationUnit_Impl(void *UserData) {
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002180 ParseTranslationUnitInfo *PTUI =
2181 static_cast<ParseTranslationUnitInfo*>(UserData);
2182 CXIndex CIdx = PTUI->CIdx;
2183 const char *source_filename = PTUI->source_filename;
Douglas Gregor2ef69442010-09-01 16:43:19 +00002184 const char * const *command_line_args = PTUI->command_line_args;
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002185 int num_command_line_args = PTUI->num_command_line_args;
2186 struct CXUnsavedFile *unsaved_files = PTUI->unsaved_files;
2187 unsigned num_unsaved_files = PTUI->num_unsaved_files;
2188 unsigned options = PTUI->options;
2189 PTUI->result = 0;
Douglas Gregor5a430212010-07-21 18:52:53 +00002190
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002191 if (!CIdx)
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002192 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002193
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002194 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
2195
Douglas Gregor44c181a2010-07-23 00:33:23 +00002196 bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
Douglas Gregordf95a132010-08-09 20:45:32 +00002197 bool CompleteTranslationUnit
2198 = ((options & CXTranslationUnit_Incomplete) == 0);
Douglas Gregor87c08a52010-08-13 22:48:40 +00002199 bool CacheCodeCompetionResults
2200 = options & CXTranslationUnit_CacheCompletionResults;
Douglas Gregor99ba2022010-10-27 17:24:53 +00002201 bool CXXPrecompilePreamble
2202 = options & CXTranslationUnit_CXXPrecompiledPreamble;
2203 bool CXXChainedPCH
2204 = options & CXTranslationUnit_CXXChainedPCH;
Douglas Gregor87c08a52010-08-13 22:48:40 +00002205
Douglas Gregor5352ac02010-01-28 00:27:43 +00002206 // Configure the diagnostics.
2207 DiagnosticOptions DiagOpts;
Douglas Gregor28019772010-04-05 23:52:57 +00002208 llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
2209 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002210
Douglas Gregor4db64a42010-01-23 00:14:00 +00002211 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
2212 for (unsigned I = 0; I != num_unsaved_files; ++I) {
Chris Lattnera0a270c2010-04-05 22:42:27 +00002213 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002214 const llvm::MemoryBuffer *Buffer
Chris Lattnera0a270c2010-04-05 22:42:27 +00002215 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
Douglas Gregor4db64a42010-01-23 00:14:00 +00002216 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2217 Buffer));
2218 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002219
Douglas Gregorb10daed2010-10-11 16:52:23 +00002220 llvm::SmallVector<const char *, 16> Args;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002221
Ted Kremenek139ba862009-10-22 00:03:57 +00002222 // The 'source_filename' argument is optional. If the caller does not
2223 // specify it then it is assumed that the source file is specified
2224 // in the actual argument list.
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002225 if (source_filename)
Douglas Gregorb10daed2010-10-11 16:52:23 +00002226 Args.push_back(source_filename);
Douglas Gregor52ddc5d2010-07-09 18:39:07 +00002227
2228 // Since the Clang C library is primarily used by batch tools dealing with
2229 // (often very broken) source code, where spell-checking can have a
2230 // significant negative impact on performance (particularly when
2231 // precompiled headers are involved), we disable it by default.
Douglas Gregorb10daed2010-10-11 16:52:23 +00002232 // Only do this if we haven't found a spell-checking-related argument.
2233 bool FoundSpellCheckingArgument = false;
2234 for (int I = 0; I != num_command_line_args; ++I) {
2235 if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 ||
2236 strcmp(command_line_args[I], "-fspell-checking") == 0) {
2237 FoundSpellCheckingArgument = true;
2238 break;
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002239 }
Douglas Gregorb10daed2010-10-11 16:52:23 +00002240 }
2241 if (!FoundSpellCheckingArgument)
2242 Args.push_back("-fno-spell-checking");
2243
2244 Args.insert(Args.end(), command_line_args,
2245 command_line_args + num_command_line_args);
Douglas Gregord93256e2010-01-28 06:00:51 +00002246
Douglas Gregor44c181a2010-07-23 00:33:23 +00002247 // Do we need the detailed preprocessing record?
2248 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
Douglas Gregorb10daed2010-10-11 16:52:23 +00002249 Args.push_back("-Xclang");
2250 Args.push_back("-detailed-preprocessing-record");
Douglas Gregor44c181a2010-07-23 00:33:23 +00002251 }
2252
Argyrios Kyrtzidis026f6912010-11-18 21:47:04 +00002253 unsigned NumErrors = Diags->getClient()->getNumErrors();
Douglas Gregorb10daed2010-10-11 16:52:23 +00002254 llvm::OwningPtr<ASTUnit> Unit(
2255 ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(),
2256 Diags,
2257 CXXIdx->getClangResourcesPath(),
2258 CXXIdx->getOnlyLocalDecls(),
Douglas Gregore47be3e2010-11-11 00:39:14 +00002259 /*CaptureDiagnostics=*/true,
Douglas Gregorb10daed2010-10-11 16:52:23 +00002260 RemappedFiles.data(),
2261 RemappedFiles.size(),
Douglas Gregorb10daed2010-10-11 16:52:23 +00002262 PrecompilePreamble,
2263 CompleteTranslationUnit,
Douglas Gregor99ba2022010-10-27 17:24:53 +00002264 CacheCodeCompetionResults,
2265 CXXPrecompilePreamble,
2266 CXXChainedPCH));
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002267
Argyrios Kyrtzidis026f6912010-11-18 21:47:04 +00002268 if (NumErrors != Diags->getClient()->getNumErrors()) {
Douglas Gregorb10daed2010-10-11 16:52:23 +00002269 // Make sure to check that 'Unit' is non-NULL.
2270 if (CXXIdx->getDisplayDiagnostics() && Unit.get()) {
2271 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
2272 DEnd = Unit->stored_diag_end();
2273 D != DEnd; ++D) {
2274 CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions());
2275 CXString Msg = clang_formatDiagnostic(&Diag,
2276 clang_defaultDiagnosticDisplayOptions());
2277 fprintf(stderr, "%s\n", clang_getCString(Msg));
2278 clang_disposeString(Msg);
2279 }
Douglas Gregor274f1902010-02-22 23:17:23 +00002280#ifdef LLVM_ON_WIN32
Douglas Gregorb10daed2010-10-11 16:52:23 +00002281 // On Windows, force a flush, since there may be multiple copies of
2282 // stderr and stdout in the file system, all with different buffers
2283 // but writing to the same device.
2284 fflush(stderr);
2285#endif
2286 }
Douglas Gregora88084b2010-02-18 18:08:43 +00002287 }
Douglas Gregord93256e2010-01-28 06:00:51 +00002288
Ted Kremeneka60ed472010-11-16 08:15:36 +00002289 PTUI->result = MakeCXTranslationUnit(Unit.take());
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002290}
2291CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx,
2292 const char *source_filename,
Douglas Gregor2ef69442010-09-01 16:43:19 +00002293 const char * const *command_line_args,
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002294 int num_command_line_args,
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00002295 struct CXUnsavedFile *unsaved_files,
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002296 unsigned num_unsaved_files,
2297 unsigned options) {
2298 ParseTranslationUnitInfo PTUI = { CIdx, source_filename, command_line_args,
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00002299 num_command_line_args, unsaved_files,
2300 num_unsaved_files, options, 0 };
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002301 llvm::CrashRecoveryContext CRC;
2302
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00002303 if (!RunSafely(CRC, clang_parseTranslationUnit_Impl, &PTUI)) {
Daniel Dunbar60a45432010-08-23 22:35:34 +00002304 fprintf(stderr, "libclang: crash detected during parsing: {\n");
2305 fprintf(stderr, " 'source_filename' : '%s'\n", source_filename);
2306 fprintf(stderr, " 'command_line_args' : [");
2307 for (int i = 0; i != num_command_line_args; ++i) {
2308 if (i)
2309 fprintf(stderr, ", ");
2310 fprintf(stderr, "'%s'", command_line_args[i]);
2311 }
2312 fprintf(stderr, "],\n");
2313 fprintf(stderr, " 'unsaved_files' : [");
2314 for (unsigned i = 0; i != num_unsaved_files; ++i) {
2315 if (i)
2316 fprintf(stderr, ", ");
2317 fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
2318 unsaved_files[i].Length);
2319 }
2320 fprintf(stderr, "],\n");
2321 fprintf(stderr, " 'options' : %d,\n", options);
2322 fprintf(stderr, "}\n");
2323
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002324 return 0;
2325 }
2326
2327 return PTUI.result;
Steve Naroff5b7d8e22009-10-15 20:04:39 +00002328}
2329
Douglas Gregor19998442010-08-13 15:35:05 +00002330unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
2331 return CXSaveTranslationUnit_None;
2332}
2333
2334int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
2335 unsigned options) {
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002336 if (!TU)
2337 return 1;
2338
Ted Kremeneka60ed472010-11-16 08:15:36 +00002339 return static_cast<ASTUnit *>(TU->TUData)->Save(FileName);
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002340}
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002341
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002342void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002343 if (CTUnit) {
2344 // If the translation unit has been marked as unsafe to free, just discard
2345 // it.
Ted Kremeneka60ed472010-11-16 08:15:36 +00002346 if (static_cast<ASTUnit *>(CTUnit->TUData)->isUnsafeToFree())
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002347 return;
2348
Ted Kremeneka60ed472010-11-16 08:15:36 +00002349 delete static_cast<ASTUnit *>(CTUnit->TUData);
2350 disposeCXStringPool(CTUnit->StringPool);
2351 delete CTUnit;
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002352 }
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00002353}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002354
Douglas Gregore1e13bf2010-08-11 15:58:42 +00002355unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
2356 return CXReparse_None;
2357}
2358
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002359struct ReparseTranslationUnitInfo {
2360 CXTranslationUnit TU;
2361 unsigned num_unsaved_files;
2362 struct CXUnsavedFile *unsaved_files;
2363 unsigned options;
2364 int result;
2365};
Douglas Gregor593b0c12010-09-23 18:47:53 +00002366
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00002367static void clang_reparseTranslationUnit_Impl(void *UserData) {
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002368 ReparseTranslationUnitInfo *RTUI =
2369 static_cast<ReparseTranslationUnitInfo*>(UserData);
2370 CXTranslationUnit TU = RTUI->TU;
2371 unsigned num_unsaved_files = RTUI->num_unsaved_files;
2372 struct CXUnsavedFile *unsaved_files = RTUI->unsaved_files;
2373 unsigned options = RTUI->options;
2374 (void) options;
2375 RTUI->result = 1;
2376
Douglas Gregorabc563f2010-07-19 21:46:24 +00002377 if (!TU)
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002378 return;
Douglas Gregor593b0c12010-09-23 18:47:53 +00002379
Ted Kremeneka60ed472010-11-16 08:15:36 +00002380 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregor593b0c12010-09-23 18:47:53 +00002381 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Douglas Gregorabc563f2010-07-19 21:46:24 +00002382
2383 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
2384 for (unsigned I = 0; I != num_unsaved_files; ++I) {
2385 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
2386 const llvm::MemoryBuffer *Buffer
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002387 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
Douglas Gregorabc563f2010-07-19 21:46:24 +00002388 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2389 Buffer));
2390 }
2391
Douglas Gregor593b0c12010-09-23 18:47:53 +00002392 if (!CXXUnit->Reparse(RemappedFiles.data(), RemappedFiles.size()))
2393 RTUI->result = 0;
Douglas Gregorabc563f2010-07-19 21:46:24 +00002394}
Douglas Gregor593b0c12010-09-23 18:47:53 +00002395
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002396int clang_reparseTranslationUnit(CXTranslationUnit TU,
2397 unsigned num_unsaved_files,
2398 struct CXUnsavedFile *unsaved_files,
2399 unsigned options) {
2400 ReparseTranslationUnitInfo RTUI = { TU, num_unsaved_files, unsaved_files,
2401 options, 0 };
2402 llvm::CrashRecoveryContext CRC;
2403
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00002404 if (!RunSafely(CRC, clang_reparseTranslationUnit_Impl, &RTUI)) {
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00002405 fprintf(stderr, "libclang: crash detected during reparsing\n");
Ted Kremeneka60ed472010-11-16 08:15:36 +00002406 static_cast<ASTUnit *>(TU->TUData)->setUnsafeToFree(true);
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002407 return 1;
2408 }
2409
Ted Kremenek1dfb26a2010-10-29 01:06:50 +00002410
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002411 return RTUI.result;
2412}
2413
Douglas Gregordf95a132010-08-09 20:45:32 +00002414
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002415CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002416 if (!CTUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002417 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002418
Ted Kremeneka60ed472010-11-16 08:15:36 +00002419 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit->TUData);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002420 return createCXString(CXXUnit->getOriginalSourceFileName(), true);
Steve Naroffaf08ddc2009-09-03 15:49:00 +00002421}
Daniel Dunbar1eb79b52009-08-28 16:30:07 +00002422
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002423CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002424 CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } };
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002425 return Result;
2426}
2427
Ted Kremenekfb480492010-01-13 21:46:36 +00002428} // end: extern "C"
Steve Naroff600866c2009-08-27 19:51:58 +00002429
Ted Kremenekfb480492010-01-13 21:46:36 +00002430//===----------------------------------------------------------------------===//
Douglas Gregor1db19de2010-01-19 21:36:55 +00002431// CXSourceLocation and CXSourceRange Operations.
2432//===----------------------------------------------------------------------===//
2433
Douglas Gregorb9790342010-01-22 21:44:22 +00002434extern "C" {
2435CXSourceLocation clang_getNullLocation() {
Douglas Gregor5352ac02010-01-28 00:27:43 +00002436 CXSourceLocation Result = { { 0, 0 }, 0 };
Douglas Gregorb9790342010-01-22 21:44:22 +00002437 return Result;
2438}
2439
2440unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) {
Daniel Dunbar90a6b9e2010-01-30 23:58:27 +00002441 return (loc1.ptr_data[0] == loc2.ptr_data[0] &&
2442 loc1.ptr_data[1] == loc2.ptr_data[1] &&
2443 loc1.int_data == loc2.int_data);
Douglas Gregorb9790342010-01-22 21:44:22 +00002444}
2445
2446CXSourceLocation clang_getLocation(CXTranslationUnit tu,
2447 CXFile file,
2448 unsigned line,
2449 unsigned column) {
Douglas Gregor42748ec2010-04-30 19:45:53 +00002450 if (!tu || !file)
Douglas Gregorb9790342010-01-22 21:44:22 +00002451 return clang_getNullLocation();
Douglas Gregor42748ec2010-04-30 19:45:53 +00002452
Ted Kremeneka60ed472010-11-16 08:15:36 +00002453 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
Douglas Gregorb9790342010-01-22 21:44:22 +00002454 SourceLocation SLoc
2455 = CXXUnit->getSourceManager().getLocation(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002456 static_cast<const FileEntry *>(file),
Douglas Gregorb9790342010-01-22 21:44:22 +00002457 line, column);
David Chisnall83889a72010-10-15 17:07:39 +00002458 if (SLoc.isInvalid()) return clang_getNullLocation();
2459
2460 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
2461}
2462
2463CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
2464 CXFile file,
2465 unsigned offset) {
2466 if (!tu || !file)
2467 return clang_getNullLocation();
2468
Ted Kremeneka60ed472010-11-16 08:15:36 +00002469 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
David Chisnall83889a72010-10-15 17:07:39 +00002470 SourceLocation Start
2471 = CXXUnit->getSourceManager().getLocation(
2472 static_cast<const FileEntry *>(file),
2473 1, 1);
2474 if (Start.isInvalid()) return clang_getNullLocation();
2475
2476 SourceLocation SLoc = Start.getFileLocWithOffset(offset);
2477
2478 if (SLoc.isInvalid()) return clang_getNullLocation();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002479
Ted Kremenek1a9a0bc2010-06-28 23:54:17 +00002480 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
Douglas Gregorb9790342010-01-22 21:44:22 +00002481}
2482
Douglas Gregor5352ac02010-01-28 00:27:43 +00002483CXSourceRange clang_getNullRange() {
2484 CXSourceRange Result = { { 0, 0 }, 0, 0 };
2485 return Result;
2486}
Daniel Dunbard52864b2010-02-14 10:02:57 +00002487
Douglas Gregor5352ac02010-01-28 00:27:43 +00002488CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) {
2489 if (begin.ptr_data[0] != end.ptr_data[0] ||
2490 begin.ptr_data[1] != end.ptr_data[1])
2491 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002492
2493 CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002494 begin.int_data, end.int_data };
Douglas Gregorb9790342010-01-22 21:44:22 +00002495 return Result;
2496}
2497
Douglas Gregor46766dc2010-01-26 19:19:08 +00002498void clang_getInstantiationLocation(CXSourceLocation location,
2499 CXFile *file,
2500 unsigned *line,
2501 unsigned *column,
2502 unsigned *offset) {
Douglas Gregor1db19de2010-01-19 21:36:55 +00002503 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2504
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002505 if (!location.ptr_data[0] || Loc.isInvalid()) {
Douglas Gregor46766dc2010-01-26 19:19:08 +00002506 if (file)
2507 *file = 0;
2508 if (line)
2509 *line = 0;
2510 if (column)
2511 *column = 0;
2512 if (offset)
2513 *offset = 0;
2514 return;
2515 }
2516
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002517 const SourceManager &SM =
2518 *static_cast<const SourceManager*>(location.ptr_data[0]);
Douglas Gregor1db19de2010-01-19 21:36:55 +00002519 SourceLocation InstLoc = SM.getInstantiationLoc(Loc);
Douglas Gregor1db19de2010-01-19 21:36:55 +00002520
2521 if (file)
2522 *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc));
2523 if (line)
2524 *line = SM.getInstantiationLineNumber(InstLoc);
2525 if (column)
2526 *column = SM.getInstantiationColumnNumber(InstLoc);
Douglas Gregore69517c2010-01-26 03:07:15 +00002527 if (offset)
Douglas Gregor46766dc2010-01-26 19:19:08 +00002528 *offset = SM.getDecomposedLoc(InstLoc).second;
Douglas Gregore69517c2010-01-26 03:07:15 +00002529}
2530
Douglas Gregora9b06d42010-11-09 06:24:54 +00002531void clang_getSpellingLocation(CXSourceLocation location,
2532 CXFile *file,
2533 unsigned *line,
2534 unsigned *column,
2535 unsigned *offset) {
2536 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2537
2538 if (!location.ptr_data[0] || Loc.isInvalid()) {
2539 if (file)
2540 *file = 0;
2541 if (line)
2542 *line = 0;
2543 if (column)
2544 *column = 0;
2545 if (offset)
2546 *offset = 0;
2547 return;
2548 }
2549
2550 const SourceManager &SM =
2551 *static_cast<const SourceManager*>(location.ptr_data[0]);
2552 SourceLocation SpellLoc = Loc;
2553 if (SpellLoc.isMacroID()) {
2554 SourceLocation SimpleSpellingLoc = SM.getImmediateSpellingLoc(SpellLoc);
2555 if (SimpleSpellingLoc.isFileID() &&
2556 SM.getFileEntryForID(SM.getDecomposedLoc(SimpleSpellingLoc).first))
2557 SpellLoc = SimpleSpellingLoc;
2558 else
2559 SpellLoc = SM.getInstantiationLoc(SpellLoc);
2560 }
2561
2562 std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(SpellLoc);
2563 FileID FID = LocInfo.first;
2564 unsigned FileOffset = LocInfo.second;
2565
2566 if (file)
2567 *file = (void *)SM.getFileEntryForID(FID);
2568 if (line)
2569 *line = SM.getLineNumber(FID, FileOffset);
2570 if (column)
2571 *column = SM.getColumnNumber(FID, FileOffset);
2572 if (offset)
2573 *offset = FileOffset;
2574}
2575
Douglas Gregor1db19de2010-01-19 21:36:55 +00002576CXSourceLocation clang_getRangeStart(CXSourceRange range) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002577 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002578 range.begin_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00002579 return Result;
2580}
2581
2582CXSourceLocation clang_getRangeEnd(CXSourceRange range) {
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002583 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002584 range.end_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00002585 return Result;
2586}
2587
Douglas Gregorb9790342010-01-22 21:44:22 +00002588} // end: extern "C"
2589
Douglas Gregor1db19de2010-01-19 21:36:55 +00002590//===----------------------------------------------------------------------===//
Ted Kremenekfb480492010-01-13 21:46:36 +00002591// CXFile Operations.
2592//===----------------------------------------------------------------------===//
2593
2594extern "C" {
Ted Kremenek74844072010-02-17 00:41:20 +00002595CXString clang_getFileName(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00002596 if (!SFile)
Ted Kremeneka60ed472010-11-16 08:15:36 +00002597 return createCXString((const char*)NULL);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002598
Steve Naroff88145032009-10-27 14:35:18 +00002599 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
Ted Kremenek74844072010-02-17 00:41:20 +00002600 return createCXString(FEnt->getName());
Steve Naroff88145032009-10-27 14:35:18 +00002601}
2602
2603time_t clang_getFileTime(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00002604 if (!SFile)
2605 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002606
Steve Naroff88145032009-10-27 14:35:18 +00002607 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
2608 return FEnt->getModificationTime();
Steve Naroffee9405e2009-09-25 21:45:39 +00002609}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002610
Douglas Gregorb9790342010-01-22 21:44:22 +00002611CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) {
2612 if (!tu)
2613 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002614
Ted Kremeneka60ed472010-11-16 08:15:36 +00002615 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002616
Douglas Gregorb9790342010-01-22 21:44:22 +00002617 FileManager &FMgr = CXXUnit->getFileManager();
Chris Lattner39b49bc2010-11-23 08:35:12 +00002618 return const_cast<FileEntry *>(FMgr.getFile(file_name));
Douglas Gregorb9790342010-01-22 21:44:22 +00002619}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002620
Ted Kremenekfb480492010-01-13 21:46:36 +00002621} // end: extern "C"
Steve Naroffee9405e2009-09-25 21:45:39 +00002622
Ted Kremenekfb480492010-01-13 21:46:36 +00002623//===----------------------------------------------------------------------===//
2624// CXCursor Operations.
2625//===----------------------------------------------------------------------===//
2626
Ted Kremenekfb480492010-01-13 21:46:36 +00002627static Decl *getDeclFromExpr(Stmt *E) {
Douglas Gregordb1314e2010-10-01 21:11:22 +00002628 if (CastExpr *CE = dyn_cast<CastExpr>(E))
2629 return getDeclFromExpr(CE->getSubExpr());
2630
Ted Kremenekfb480492010-01-13 21:46:36 +00002631 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
2632 return RefExpr->getDecl();
Douglas Gregor38f28c12010-10-22 22:24:08 +00002633 if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
2634 return RefExpr->getDecl();
Ted Kremenekfb480492010-01-13 21:46:36 +00002635 if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
2636 return ME->getMemberDecl();
2637 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
2638 return RE->getDecl();
Douglas Gregordb1314e2010-10-01 21:11:22 +00002639 if (ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E))
John McCall12f78a62010-12-02 01:19:52 +00002640 return PRE->isExplicitProperty() ? PRE->getExplicitProperty() : 0;
Douglas Gregordb1314e2010-10-01 21:11:22 +00002641
Ted Kremenekfb480492010-01-13 21:46:36 +00002642 if (CallExpr *CE = dyn_cast<CallExpr>(E))
2643 return getDeclFromExpr(CE->getCallee());
Douglas Gregor93798e22010-11-05 21:11:19 +00002644 if (CXXConstructExpr *CE = llvm::dyn_cast<CXXConstructExpr>(E))
2645 if (!CE->isElidable())
2646 return CE->getConstructor();
Ted Kremenekfb480492010-01-13 21:46:36 +00002647 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
2648 return OME->getMethodDecl();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002649
Douglas Gregordb1314e2010-10-01 21:11:22 +00002650 if (ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E))
2651 return PE->getProtocol();
Douglas Gregorc7793c72011-01-15 01:15:58 +00002652 if (SubstNonTypeTemplateParmPackExpr *NTTP
2653 = dyn_cast<SubstNonTypeTemplateParmPackExpr>(E))
2654 return NTTP->getParameterPack();
Douglas Gregordb1314e2010-10-01 21:11:22 +00002655
Ted Kremenekfb480492010-01-13 21:46:36 +00002656 return 0;
2657}
2658
Daniel Dunbarc29f4c32010-02-02 05:00:22 +00002659static SourceLocation getLocationFromExpr(Expr *E) {
2660 if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
2661 return /*FIXME:*/Msg->getLeftLoc();
2662 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
2663 return DRE->getLocation();
Douglas Gregor38f28c12010-10-22 22:24:08 +00002664 if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
2665 return RefExpr->getLocation();
Daniel Dunbarc29f4c32010-02-02 05:00:22 +00002666 if (MemberExpr *Member = dyn_cast<MemberExpr>(E))
2667 return Member->getMemberLoc();
2668 if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
2669 return Ivar->getLocation();
2670 return E->getLocStart();
2671}
2672
Ted Kremenekfb480492010-01-13 21:46:36 +00002673extern "C" {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002674
2675unsigned clang_visitChildren(CXCursor parent,
Douglas Gregorb1373d02010-01-20 20:59:29 +00002676 CXCursorVisitor visitor,
2677 CXClientData client_data) {
Ted Kremeneka60ed472010-11-16 08:15:36 +00002678 CursorVisitor CursorVis(getCursorTU(parent), visitor, client_data,
2679 getCursorASTUnit(parent)->getMaxPCHLevel());
Douglas Gregorb1373d02010-01-20 20:59:29 +00002680 return CursorVis.VisitChildren(parent);
2681}
2682
David Chisnall3387c652010-11-03 14:12:26 +00002683#ifndef __has_feature
2684#define __has_feature(x) 0
2685#endif
2686#if __has_feature(blocks)
2687typedef enum CXChildVisitResult
2688 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
2689
2690static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
2691 CXClientData client_data) {
2692 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
2693 return block(cursor, parent);
2694}
2695#else
2696// If we are compiled with a compiler that doesn't have native blocks support,
2697// define and call the block manually, so the
2698typedef struct _CXChildVisitResult
2699{
2700 void *isa;
2701 int flags;
2702 int reserved;
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00002703 enum CXChildVisitResult(*invoke)(struct _CXChildVisitResult*, CXCursor,
2704 CXCursor);
David Chisnall3387c652010-11-03 14:12:26 +00002705} *CXCursorVisitorBlock;
2706
2707static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
2708 CXClientData client_data) {
2709 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
2710 return block->invoke(block, cursor, parent);
2711}
2712#endif
2713
2714
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00002715unsigned clang_visitChildrenWithBlock(CXCursor parent,
2716 CXCursorVisitorBlock block) {
David Chisnall3387c652010-11-03 14:12:26 +00002717 return clang_visitChildren(parent, visitWithBlock, block);
2718}
2719
Douglas Gregor78205d42010-01-20 21:45:58 +00002720static CXString getDeclSpelling(Decl *D) {
2721 NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D);
Douglas Gregore3c60a72010-11-17 00:13:31 +00002722 if (!ND) {
2723 if (ObjCPropertyImplDecl *PropImpl =llvm::dyn_cast<ObjCPropertyImplDecl>(D))
2724 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
2725 return createCXString(Property->getIdentifier()->getName());
2726
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002727 return createCXString("");
Douglas Gregore3c60a72010-11-17 00:13:31 +00002728 }
2729
Douglas Gregor78205d42010-01-20 21:45:58 +00002730 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002731 return createCXString(OMD->getSelector().getAsString());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002732
Douglas Gregor78205d42010-01-20 21:45:58 +00002733 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
2734 // No, this isn't the same as the code below. getIdentifier() is non-virtual
2735 // and returns different names. NamedDecl returns the class name and
2736 // ObjCCategoryImplDecl returns the category name.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002737 return createCXString(CIMP->getIdentifier()->getNameStart());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002738
Douglas Gregor0a35bce2010-09-01 03:07:18 +00002739 if (isa<UsingDirectiveDecl>(D))
2740 return createCXString("");
2741
Ted Kremenek50aa6ac2010-05-19 21:51:10 +00002742 llvm::SmallString<1024> S;
2743 llvm::raw_svector_ostream os(S);
2744 ND->printName(os);
2745
2746 return createCXString(os.str());
Douglas Gregor78205d42010-01-20 21:45:58 +00002747}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002748
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002749CXString clang_getCursorSpelling(CXCursor C) {
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002750 if (clang_isTranslationUnit(C.kind))
Ted Kremeneka60ed472010-11-16 08:15:36 +00002751 return clang_getTranslationUnitSpelling(
2752 static_cast<CXTranslationUnit>(C.data[2]));
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002753
Steve Narofff334b4e2009-09-02 18:26:48 +00002754 if (clang_isReference(C.kind)) {
2755 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +00002756 case CXCursor_ObjCSuperClassRef: {
Douglas Gregor2e331b92010-01-16 14:00:32 +00002757 ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002758 return createCXString(Super->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00002759 }
2760 case CXCursor_ObjCClassRef: {
Douglas Gregor1adb0822010-01-16 17:14:40 +00002761 ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002762 return createCXString(Class->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00002763 }
2764 case CXCursor_ObjCProtocolRef: {
Douglas Gregor78db0cd2010-01-16 15:44:18 +00002765 ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
Douglas Gregorf46034a2010-01-18 23:41:10 +00002766 assert(OID && "getCursorSpelling(): Missing protocol decl");
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002767 return createCXString(OID->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00002768 }
Ted Kremenek3064ef92010-08-27 21:34:58 +00002769 case CXCursor_CXXBaseSpecifier: {
2770 CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
2771 return createCXString(B->getType().getAsString());
2772 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002773 case CXCursor_TypeRef: {
2774 TypeDecl *Type = getCursorTypeRef(C).first;
2775 assert(Type && "Missing type decl");
2776
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002777 return createCXString(getCursorContext(C).getTypeDeclType(Type).
2778 getAsString());
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002779 }
Douglas Gregor0b36e612010-08-31 20:37:03 +00002780 case CXCursor_TemplateRef: {
2781 TemplateDecl *Template = getCursorTemplateRef(C).first;
Douglas Gregor69319002010-08-31 23:48:11 +00002782 assert(Template && "Missing template decl");
Douglas Gregor0b36e612010-08-31 20:37:03 +00002783
2784 return createCXString(Template->getNameAsString());
2785 }
Douglas Gregor69319002010-08-31 23:48:11 +00002786
2787 case CXCursor_NamespaceRef: {
2788 NamedDecl *NS = getCursorNamespaceRef(C).first;
2789 assert(NS && "Missing namespace decl");
2790
2791 return createCXString(NS->getNameAsString());
2792 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002793
Douglas Gregora67e03f2010-09-09 21:42:20 +00002794 case CXCursor_MemberRef: {
2795 FieldDecl *Field = getCursorMemberRef(C).first;
2796 assert(Field && "Missing member decl");
2797
2798 return createCXString(Field->getNameAsString());
2799 }
2800
Douglas Gregor36897b02010-09-10 00:22:18 +00002801 case CXCursor_LabelRef: {
2802 LabelStmt *Label = getCursorLabelRef(C).first;
2803 assert(Label && "Missing label");
2804
2805 return createCXString(Label->getID()->getName());
2806 }
2807
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00002808 case CXCursor_OverloadedDeclRef: {
2809 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
2810 if (Decl *D = Storage.dyn_cast<Decl *>()) {
2811 if (NamedDecl *ND = dyn_cast<NamedDecl>(D))
2812 return createCXString(ND->getNameAsString());
2813 return createCXString("");
2814 }
2815 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
2816 return createCXString(E->getName().getAsString());
2817 OverloadedTemplateStorage *Ovl
2818 = Storage.get<OverloadedTemplateStorage*>();
2819 if (Ovl->size() == 0)
2820 return createCXString("");
2821 return createCXString((*Ovl->begin())->getNameAsString());
2822 }
2823
Daniel Dunbaracca7252009-11-30 20:42:49 +00002824 default:
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002825 return createCXString("<not implemented>");
Steve Narofff334b4e2009-09-02 18:26:48 +00002826 }
2827 }
Douglas Gregor97b98722010-01-19 23:20:36 +00002828
2829 if (clang_isExpression(C.kind)) {
2830 Decl *D = getDeclFromExpr(getCursorExpr(C));
2831 if (D)
Douglas Gregor78205d42010-01-20 21:45:58 +00002832 return getDeclSpelling(D);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002833 return createCXString("");
Douglas Gregor97b98722010-01-19 23:20:36 +00002834 }
2835
Douglas Gregor36897b02010-09-10 00:22:18 +00002836 if (clang_isStatement(C.kind)) {
2837 Stmt *S = getCursorStmt(C);
2838 if (LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S))
2839 return createCXString(Label->getID()->getName());
2840
2841 return createCXString("");
2842 }
2843
Douglas Gregor4ae8f292010-03-18 17:52:52 +00002844 if (C.kind == CXCursor_MacroInstantiation)
2845 return createCXString(getCursorMacroInstantiation(C)->getName()
2846 ->getNameStart());
2847
Douglas Gregor572feb22010-03-18 18:04:21 +00002848 if (C.kind == CXCursor_MacroDefinition)
2849 return createCXString(getCursorMacroDefinition(C)->getName()
2850 ->getNameStart());
2851
Douglas Gregorecdcb882010-10-20 22:00:55 +00002852 if (C.kind == CXCursor_InclusionDirective)
2853 return createCXString(getCursorInclusionDirective(C)->getFileName());
2854
Douglas Gregor60cbfac2010-01-25 16:56:17 +00002855 if (clang_isDeclaration(C.kind))
2856 return getDeclSpelling(getCursorDecl(C));
Ted Kremeneke68fff62010-02-17 00:41:32 +00002857
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002858 return createCXString("");
Steve Narofff334b4e2009-09-02 18:26:48 +00002859}
2860
Douglas Gregor358559d2010-10-02 22:49:11 +00002861CXString clang_getCursorDisplayName(CXCursor C) {
2862 if (!clang_isDeclaration(C.kind))
2863 return clang_getCursorSpelling(C);
2864
2865 Decl *D = getCursorDecl(C);
2866 if (!D)
2867 return createCXString("");
2868
2869 PrintingPolicy &Policy = getCursorContext(C).PrintingPolicy;
2870 if (FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D))
2871 D = FunTmpl->getTemplatedDecl();
2872
2873 if (FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
2874 llvm::SmallString<64> Str;
2875 llvm::raw_svector_ostream OS(Str);
2876 OS << Function->getNameAsString();
2877 if (Function->getPrimaryTemplate())
2878 OS << "<>";
2879 OS << "(";
2880 for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) {
2881 if (I)
2882 OS << ", ";
2883 OS << Function->getParamDecl(I)->getType().getAsString(Policy);
2884 }
2885
2886 if (Function->isVariadic()) {
2887 if (Function->getNumParams())
2888 OS << ", ";
2889 OS << "...";
2890 }
2891 OS << ")";
2892 return createCXString(OS.str());
2893 }
2894
2895 if (ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) {
2896 llvm::SmallString<64> Str;
2897 llvm::raw_svector_ostream OS(Str);
2898 OS << ClassTemplate->getNameAsString();
2899 OS << "<";
2900 TemplateParameterList *Params = ClassTemplate->getTemplateParameters();
2901 for (unsigned I = 0, N = Params->size(); I != N; ++I) {
2902 if (I)
2903 OS << ", ";
2904
2905 NamedDecl *Param = Params->getParam(I);
2906 if (Param->getIdentifier()) {
2907 OS << Param->getIdentifier()->getName();
2908 continue;
2909 }
2910
2911 // There is no parameter name, which makes this tricky. Try to come up
2912 // with something useful that isn't too long.
2913 if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
2914 OS << (TTP->wasDeclaredWithTypename()? "typename" : "class");
2915 else if (NonTypeTemplateParmDecl *NTTP
2916 = dyn_cast<NonTypeTemplateParmDecl>(Param))
2917 OS << NTTP->getType().getAsString(Policy);
2918 else
2919 OS << "template<...> class";
2920 }
2921
2922 OS << ">";
2923 return createCXString(OS.str());
2924 }
2925
2926 if (ClassTemplateSpecializationDecl *ClassSpec
2927 = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
2928 // If the type was explicitly written, use that.
2929 if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten())
2930 return createCXString(TSInfo->getType().getAsString(Policy));
2931
2932 llvm::SmallString<64> Str;
2933 llvm::raw_svector_ostream OS(Str);
2934 OS << ClassSpec->getNameAsString();
2935 OS << TemplateSpecializationType::PrintTemplateArgumentList(
Douglas Gregor910f8002010-11-07 23:05:16 +00002936 ClassSpec->getTemplateArgs().data(),
2937 ClassSpec->getTemplateArgs().size(),
Douglas Gregor358559d2010-10-02 22:49:11 +00002938 Policy);
2939 return createCXString(OS.str());
2940 }
2941
2942 return clang_getCursorSpelling(C);
2943}
2944
Ted Kremeneke68fff62010-02-17 00:41:32 +00002945CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
Steve Naroff89922f82009-08-31 00:59:03 +00002946 switch (Kind) {
Ted Kremeneke68fff62010-02-17 00:41:32 +00002947 case CXCursor_FunctionDecl:
2948 return createCXString("FunctionDecl");
2949 case CXCursor_TypedefDecl:
2950 return createCXString("TypedefDecl");
2951 case CXCursor_EnumDecl:
2952 return createCXString("EnumDecl");
2953 case CXCursor_EnumConstantDecl:
2954 return createCXString("EnumConstantDecl");
2955 case CXCursor_StructDecl:
2956 return createCXString("StructDecl");
2957 case CXCursor_UnionDecl:
2958 return createCXString("UnionDecl");
2959 case CXCursor_ClassDecl:
2960 return createCXString("ClassDecl");
2961 case CXCursor_FieldDecl:
2962 return createCXString("FieldDecl");
2963 case CXCursor_VarDecl:
2964 return createCXString("VarDecl");
2965 case CXCursor_ParmDecl:
2966 return createCXString("ParmDecl");
2967 case CXCursor_ObjCInterfaceDecl:
2968 return createCXString("ObjCInterfaceDecl");
2969 case CXCursor_ObjCCategoryDecl:
2970 return createCXString("ObjCCategoryDecl");
2971 case CXCursor_ObjCProtocolDecl:
2972 return createCXString("ObjCProtocolDecl");
2973 case CXCursor_ObjCPropertyDecl:
2974 return createCXString("ObjCPropertyDecl");
2975 case CXCursor_ObjCIvarDecl:
2976 return createCXString("ObjCIvarDecl");
2977 case CXCursor_ObjCInstanceMethodDecl:
2978 return createCXString("ObjCInstanceMethodDecl");
2979 case CXCursor_ObjCClassMethodDecl:
2980 return createCXString("ObjCClassMethodDecl");
2981 case CXCursor_ObjCImplementationDecl:
2982 return createCXString("ObjCImplementationDecl");
2983 case CXCursor_ObjCCategoryImplDecl:
2984 return createCXString("ObjCCategoryImplDecl");
Ted Kremenek8bd5a692010-04-13 23:39:06 +00002985 case CXCursor_CXXMethod:
2986 return createCXString("CXXMethod");
Ted Kremeneke68fff62010-02-17 00:41:32 +00002987 case CXCursor_UnexposedDecl:
2988 return createCXString("UnexposedDecl");
2989 case CXCursor_ObjCSuperClassRef:
2990 return createCXString("ObjCSuperClassRef");
2991 case CXCursor_ObjCProtocolRef:
2992 return createCXString("ObjCProtocolRef");
2993 case CXCursor_ObjCClassRef:
2994 return createCXString("ObjCClassRef");
2995 case CXCursor_TypeRef:
2996 return createCXString("TypeRef");
Douglas Gregor0b36e612010-08-31 20:37:03 +00002997 case CXCursor_TemplateRef:
2998 return createCXString("TemplateRef");
Douglas Gregor69319002010-08-31 23:48:11 +00002999 case CXCursor_NamespaceRef:
3000 return createCXString("NamespaceRef");
Douglas Gregora67e03f2010-09-09 21:42:20 +00003001 case CXCursor_MemberRef:
3002 return createCXString("MemberRef");
Douglas Gregor36897b02010-09-10 00:22:18 +00003003 case CXCursor_LabelRef:
3004 return createCXString("LabelRef");
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003005 case CXCursor_OverloadedDeclRef:
3006 return createCXString("OverloadedDeclRef");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003007 case CXCursor_UnexposedExpr:
3008 return createCXString("UnexposedExpr");
Ted Kremenek1ee6cad2010-04-11 21:47:37 +00003009 case CXCursor_BlockExpr:
3010 return createCXString("BlockExpr");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003011 case CXCursor_DeclRefExpr:
3012 return createCXString("DeclRefExpr");
3013 case CXCursor_MemberRefExpr:
3014 return createCXString("MemberRefExpr");
3015 case CXCursor_CallExpr:
3016 return createCXString("CallExpr");
3017 case CXCursor_ObjCMessageExpr:
3018 return createCXString("ObjCMessageExpr");
3019 case CXCursor_UnexposedStmt:
3020 return createCXString("UnexposedStmt");
Douglas Gregor36897b02010-09-10 00:22:18 +00003021 case CXCursor_LabelStmt:
3022 return createCXString("LabelStmt");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003023 case CXCursor_InvalidFile:
3024 return createCXString("InvalidFile");
Ted Kremenek292db642010-03-19 20:39:05 +00003025 case CXCursor_InvalidCode:
3026 return createCXString("InvalidCode");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003027 case CXCursor_NoDeclFound:
3028 return createCXString("NoDeclFound");
3029 case CXCursor_NotImplemented:
3030 return createCXString("NotImplemented");
3031 case CXCursor_TranslationUnit:
3032 return createCXString("TranslationUnit");
Ted Kremeneke77f4432010-02-18 03:09:07 +00003033 case CXCursor_UnexposedAttr:
3034 return createCXString("UnexposedAttr");
3035 case CXCursor_IBActionAttr:
3036 return createCXString("attribute(ibaction)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003037 case CXCursor_IBOutletAttr:
3038 return createCXString("attribute(iboutlet)");
Ted Kremenek857e9182010-05-19 17:38:06 +00003039 case CXCursor_IBOutletCollectionAttr:
3040 return createCXString("attribute(iboutletcollection)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003041 case CXCursor_PreprocessingDirective:
3042 return createCXString("preprocessing directive");
Douglas Gregor572feb22010-03-18 18:04:21 +00003043 case CXCursor_MacroDefinition:
3044 return createCXString("macro definition");
Douglas Gregor48072312010-03-18 15:23:44 +00003045 case CXCursor_MacroInstantiation:
3046 return createCXString("macro instantiation");
Douglas Gregorecdcb882010-10-20 22:00:55 +00003047 case CXCursor_InclusionDirective:
3048 return createCXString("inclusion directive");
Ted Kremenek8f06e0e2010-05-06 23:38:21 +00003049 case CXCursor_Namespace:
3050 return createCXString("Namespace");
Ted Kremeneka0536d82010-05-07 01:04:29 +00003051 case CXCursor_LinkageSpec:
3052 return createCXString("LinkageSpec");
Ted Kremenek3064ef92010-08-27 21:34:58 +00003053 case CXCursor_CXXBaseSpecifier:
3054 return createCXString("C++ base class specifier");
Douglas Gregor01829d32010-08-31 14:41:23 +00003055 case CXCursor_Constructor:
3056 return createCXString("CXXConstructor");
3057 case CXCursor_Destructor:
3058 return createCXString("CXXDestructor");
3059 case CXCursor_ConversionFunction:
3060 return createCXString("CXXConversion");
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00003061 case CXCursor_TemplateTypeParameter:
3062 return createCXString("TemplateTypeParameter");
3063 case CXCursor_NonTypeTemplateParameter:
3064 return createCXString("NonTypeTemplateParameter");
3065 case CXCursor_TemplateTemplateParameter:
3066 return createCXString("TemplateTemplateParameter");
3067 case CXCursor_FunctionTemplate:
3068 return createCXString("FunctionTemplate");
Douglas Gregor39d6f072010-08-31 19:02:00 +00003069 case CXCursor_ClassTemplate:
3070 return createCXString("ClassTemplate");
Douglas Gregor74dbe642010-08-31 19:31:58 +00003071 case CXCursor_ClassTemplatePartialSpecialization:
3072 return createCXString("ClassTemplatePartialSpecialization");
Douglas Gregor69319002010-08-31 23:48:11 +00003073 case CXCursor_NamespaceAlias:
3074 return createCXString("NamespaceAlias");
Douglas Gregor0a35bce2010-09-01 03:07:18 +00003075 case CXCursor_UsingDirective:
3076 return createCXString("UsingDirective");
Douglas Gregor7e242562010-09-01 19:52:22 +00003077 case CXCursor_UsingDeclaration:
3078 return createCXString("UsingDeclaration");
Steve Naroff89922f82009-08-31 00:59:03 +00003079 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00003080
Ted Kremenekdeb06bd2010-01-16 02:02:09 +00003081 llvm_unreachable("Unhandled CXCursorKind");
Ted Kremeneka60ed472010-11-16 08:15:36 +00003082 return createCXString((const char*) 0);
Steve Naroff600866c2009-08-27 19:51:58 +00003083}
Steve Naroff89922f82009-08-31 00:59:03 +00003084
Ted Kremeneke68fff62010-02-17 00:41:32 +00003085enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
3086 CXCursor parent,
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003087 CXClientData client_data) {
3088 CXCursor *BestCursor = static_cast<CXCursor *>(client_data);
Douglas Gregor93798e22010-11-05 21:11:19 +00003089
3090 // If our current best cursor is the construction of a temporary object,
3091 // don't replace that cursor with a type reference, because we want
3092 // clang_getCursor() to point at the constructor.
3093 if (clang_isExpression(BestCursor->kind) &&
3094 isa<CXXTemporaryObjectExpr>(getCursorExpr(*BestCursor)) &&
3095 cursor.kind == CXCursor_TypeRef)
3096 return CXChildVisit_Recurse;
3097
Douglas Gregor85fe1562010-12-10 07:23:11 +00003098 // Don't override a preprocessing cursor with another preprocessing
3099 // cursor; we want the outermost preprocessing cursor.
3100 if (clang_isPreprocessing(cursor.kind) &&
3101 clang_isPreprocessing(BestCursor->kind))
3102 return CXChildVisit_Recurse;
3103
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003104 *BestCursor = cursor;
3105 return CXChildVisit_Recurse;
3106}
Ted Kremeneke68fff62010-02-17 00:41:32 +00003107
Douglas Gregorb9790342010-01-22 21:44:22 +00003108CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
3109 if (!TU)
Ted Kremenekf4629892010-01-14 01:51:23 +00003110 return clang_getNullCursor();
Ted Kremeneke68fff62010-02-17 00:41:32 +00003111
Ted Kremeneka60ed472010-11-16 08:15:36 +00003112 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregorbdf60622010-03-05 21:16:25 +00003113 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3114
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003115 // Translate the given source location to make it point at the beginning of
3116 // the token under the cursor.
Ted Kremeneka297de22010-01-25 22:34:44 +00003117 SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
Ted Kremeneka629ea42010-07-29 00:52:07 +00003118
3119 // Guard against an invalid SourceLocation, or we may assert in one
3120 // of the following calls.
3121 if (SLoc.isInvalid())
3122 return clang_getNullCursor();
3123
Douglas Gregor40749ee2010-11-03 00:35:38 +00003124 bool Logging = getenv("LIBCLANG_LOGGING");
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003125 SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
3126 CXXUnit->getASTContext().getLangOptions());
3127
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003128 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
3129 if (SLoc.isValid()) {
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003130 // FIXME: Would be great to have a "hint" cursor, then walk from that
3131 // hint cursor upward until we find a cursor whose source range encloses
3132 // the region of interest, rather than starting from the translation unit.
Ted Kremeneka60ed472010-11-16 08:15:36 +00003133 CXCursor Parent = clang_getTranslationUnitCursor(TU);
3134 CursorVisitor CursorVis(TU, GetCursorVisitor, &Result,
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003135 Decl::MaxPCHLevel, SourceLocation(SLoc));
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003136 CursorVis.VisitChildren(Parent);
Steve Naroff77128dd2009-09-15 20:25:34 +00003137 }
Douglas Gregor40749ee2010-11-03 00:35:38 +00003138
3139 if (Logging) {
3140 CXFile SearchFile;
3141 unsigned SearchLine, SearchColumn;
3142 CXFile ResultFile;
3143 unsigned ResultLine, ResultColumn;
Douglas Gregor66537982010-11-17 17:14:07 +00003144 CXString SearchFileName, ResultFileName, KindSpelling, USR;
3145 const char *IsDef = clang_isCursorDefinition(Result)? " (Definition)" : "";
Douglas Gregor40749ee2010-11-03 00:35:38 +00003146 CXSourceLocation ResultLoc = clang_getCursorLocation(Result);
3147
3148 clang_getInstantiationLocation(Loc, &SearchFile, &SearchLine, &SearchColumn,
3149 0);
3150 clang_getInstantiationLocation(ResultLoc, &ResultFile, &ResultLine,
3151 &ResultColumn, 0);
3152 SearchFileName = clang_getFileName(SearchFile);
3153 ResultFileName = clang_getFileName(ResultFile);
3154 KindSpelling = clang_getCursorKindSpelling(Result.kind);
Douglas Gregor66537982010-11-17 17:14:07 +00003155 USR = clang_getCursorUSR(Result);
3156 fprintf(stderr, "clang_getCursor(%s:%d:%d) = %s(%s:%d:%d):%s%s\n",
Douglas Gregor40749ee2010-11-03 00:35:38 +00003157 clang_getCString(SearchFileName), SearchLine, SearchColumn,
3158 clang_getCString(KindSpelling),
Douglas Gregor66537982010-11-17 17:14:07 +00003159 clang_getCString(ResultFileName), ResultLine, ResultColumn,
3160 clang_getCString(USR), IsDef);
Douglas Gregor40749ee2010-11-03 00:35:38 +00003161 clang_disposeString(SearchFileName);
3162 clang_disposeString(ResultFileName);
3163 clang_disposeString(KindSpelling);
Douglas Gregor66537982010-11-17 17:14:07 +00003164 clang_disposeString(USR);
Douglas Gregor0aefbd82010-12-10 01:45:00 +00003165
3166 CXCursor Definition = clang_getCursorDefinition(Result);
3167 if (!clang_equalCursors(Definition, clang_getNullCursor())) {
3168 CXSourceLocation DefinitionLoc = clang_getCursorLocation(Definition);
3169 CXString DefinitionKindSpelling
3170 = clang_getCursorKindSpelling(Definition.kind);
3171 CXFile DefinitionFile;
3172 unsigned DefinitionLine, DefinitionColumn;
3173 clang_getInstantiationLocation(DefinitionLoc, &DefinitionFile,
3174 &DefinitionLine, &DefinitionColumn, 0);
3175 CXString DefinitionFileName = clang_getFileName(DefinitionFile);
3176 fprintf(stderr, " -> %s(%s:%d:%d)\n",
3177 clang_getCString(DefinitionKindSpelling),
3178 clang_getCString(DefinitionFileName),
3179 DefinitionLine, DefinitionColumn);
3180 clang_disposeString(DefinitionFileName);
3181 clang_disposeString(DefinitionKindSpelling);
3182 }
Douglas Gregor40749ee2010-11-03 00:35:38 +00003183 }
3184
Ted Kremeneke68fff62010-02-17 00:41:32 +00003185 return Result;
Steve Naroff600866c2009-08-27 19:51:58 +00003186}
3187
Ted Kremenek73885552009-11-17 19:28:59 +00003188CXCursor clang_getNullCursor(void) {
Douglas Gregor5bfb8c12010-01-20 23:34:41 +00003189 return MakeCXCursorInvalid(CXCursor_InvalidFile);
Ted Kremenek73885552009-11-17 19:28:59 +00003190}
3191
3192unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
Douglas Gregor283cae32010-01-15 21:56:13 +00003193 return X == Y;
Ted Kremenek73885552009-11-17 19:28:59 +00003194}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00003195
Douglas Gregor9ce55842010-11-20 00:09:34 +00003196unsigned clang_hashCursor(CXCursor C) {
3197 unsigned Index = 0;
3198 if (clang_isExpression(C.kind) || clang_isStatement(C.kind))
3199 Index = 1;
3200
3201 return llvm::DenseMapInfo<std::pair<unsigned, void*> >::getHashValue(
3202 std::make_pair(C.kind, C.data[Index]));
3203}
3204
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003205unsigned clang_isInvalid(enum CXCursorKind K) {
Steve Naroff77128dd2009-09-15 20:25:34 +00003206 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
3207}
3208
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003209unsigned clang_isDeclaration(enum CXCursorKind K) {
Steve Naroff89922f82009-08-31 00:59:03 +00003210 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
3211}
Steve Naroff2d4d6292009-08-31 14:26:51 +00003212
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003213unsigned clang_isReference(enum CXCursorKind K) {
Steve Narofff334b4e2009-09-02 18:26:48 +00003214 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
3215}
3216
Douglas Gregor97b98722010-01-19 23:20:36 +00003217unsigned clang_isExpression(enum CXCursorKind K) {
3218 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
3219}
3220
3221unsigned clang_isStatement(enum CXCursorKind K) {
3222 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
3223}
3224
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00003225unsigned clang_isTranslationUnit(enum CXCursorKind K) {
3226 return K == CXCursor_TranslationUnit;
3227}
3228
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003229unsigned clang_isPreprocessing(enum CXCursorKind K) {
3230 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
3231}
3232
Ted Kremenekad6eff62010-03-08 21:17:29 +00003233unsigned clang_isUnexposed(enum CXCursorKind K) {
3234 switch (K) {
3235 case CXCursor_UnexposedDecl:
3236 case CXCursor_UnexposedExpr:
3237 case CXCursor_UnexposedStmt:
3238 case CXCursor_UnexposedAttr:
3239 return true;
3240 default:
3241 return false;
3242 }
3243}
3244
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003245CXCursorKind clang_getCursorKind(CXCursor C) {
Steve Naroff9efa7672009-09-04 15:44:05 +00003246 return C.kind;
3247}
3248
Douglas Gregor98258af2010-01-18 22:46:11 +00003249CXSourceLocation clang_getCursorLocation(CXCursor C) {
3250 if (clang_isReference(C.kind)) {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003251 switch (C.kind) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003252 case CXCursor_ObjCSuperClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003253 std::pair<ObjCInterfaceDecl *, SourceLocation> P
3254 = getCursorObjCSuperClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003255 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003256 }
3257
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003258 case CXCursor_ObjCProtocolRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003259 std::pair<ObjCProtocolDecl *, SourceLocation> P
3260 = getCursorObjCProtocolRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003261 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003262 }
3263
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003264 case CXCursor_ObjCClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003265 std::pair<ObjCInterfaceDecl *, SourceLocation> P
3266 = getCursorObjCClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003267 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003268 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003269
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003270 case CXCursor_TypeRef: {
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003271 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003272 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003273 }
Douglas Gregor0b36e612010-08-31 20:37:03 +00003274
3275 case CXCursor_TemplateRef: {
3276 std::pair<TemplateDecl *, SourceLocation> P = getCursorTemplateRef(C);
3277 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3278 }
3279
Douglas Gregor69319002010-08-31 23:48:11 +00003280 case CXCursor_NamespaceRef: {
3281 std::pair<NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
3282 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3283 }
3284
Douglas Gregora67e03f2010-09-09 21:42:20 +00003285 case CXCursor_MemberRef: {
3286 std::pair<FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
3287 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3288 }
3289
Ted Kremenek3064ef92010-08-27 21:34:58 +00003290 case CXCursor_CXXBaseSpecifier: {
Douglas Gregor1b0f7af2010-10-02 19:51:13 +00003291 CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C);
3292 if (!BaseSpec)
3293 return clang_getNullLocation();
3294
3295 if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo())
3296 return cxloc::translateSourceLocation(getCursorContext(C),
3297 TSInfo->getTypeLoc().getBeginLoc());
3298
3299 return cxloc::translateSourceLocation(getCursorContext(C),
3300 BaseSpec->getSourceRange().getBegin());
Ted Kremenek3064ef92010-08-27 21:34:58 +00003301 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003302
Douglas Gregor36897b02010-09-10 00:22:18 +00003303 case CXCursor_LabelRef: {
3304 std::pair<LabelStmt *, SourceLocation> P = getCursorLabelRef(C);
3305 return cxloc::translateSourceLocation(getCursorContext(C), P.second);
3306 }
3307
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003308 case CXCursor_OverloadedDeclRef:
3309 return cxloc::translateSourceLocation(getCursorContext(C),
3310 getCursorOverloadedDeclRef(C).second);
3311
Douglas Gregorf46034a2010-01-18 23:41:10 +00003312 default:
3313 // FIXME: Need a way to enumerate all non-reference cases.
3314 llvm_unreachable("Missed a reference kind");
3315 }
Douglas Gregor98258af2010-01-18 22:46:11 +00003316 }
Douglas Gregor97b98722010-01-19 23:20:36 +00003317
3318 if (clang_isExpression(C.kind))
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003319 return cxloc::translateSourceLocation(getCursorContext(C),
Douglas Gregor97b98722010-01-19 23:20:36 +00003320 getLocationFromExpr(getCursorExpr(C)));
3321
Douglas Gregor36897b02010-09-10 00:22:18 +00003322 if (clang_isStatement(C.kind))
3323 return cxloc::translateSourceLocation(getCursorContext(C),
3324 getCursorStmt(C)->getLocStart());
3325
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003326 if (C.kind == CXCursor_PreprocessingDirective) {
3327 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
3328 return cxloc::translateSourceLocation(getCursorContext(C), L);
3329 }
Douglas Gregor48072312010-03-18 15:23:44 +00003330
3331 if (C.kind == CXCursor_MacroInstantiation) {
Douglas Gregor4ae8f292010-03-18 17:52:52 +00003332 SourceLocation L
3333 = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin();
Douglas Gregor48072312010-03-18 15:23:44 +00003334 return cxloc::translateSourceLocation(getCursorContext(C), L);
3335 }
Douglas Gregor572feb22010-03-18 18:04:21 +00003336
3337 if (C.kind == CXCursor_MacroDefinition) {
3338 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
3339 return cxloc::translateSourceLocation(getCursorContext(C), L);
3340 }
Douglas Gregorecdcb882010-10-20 22:00:55 +00003341
3342 if (C.kind == CXCursor_InclusionDirective) {
3343 SourceLocation L
3344 = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin();
3345 return cxloc::translateSourceLocation(getCursorContext(C), L);
3346 }
3347
Ted Kremenek9a700d22010-05-12 06:16:13 +00003348 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
Douglas Gregor5352ac02010-01-28 00:27:43 +00003349 return clang_getNullLocation();
Douglas Gregor98258af2010-01-18 22:46:11 +00003350
Douglas Gregorf46034a2010-01-18 23:41:10 +00003351 Decl *D = getCursorDecl(C);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003352 SourceLocation Loc = D->getLocation();
3353 if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D))
3354 Loc = Class->getClassLoc();
Ted Kremenek007a7c92010-11-01 23:26:51 +00003355 // FIXME: Multiple variables declared in a single declaration
3356 // currently lack the information needed to correctly determine their
3357 // ranges when accounting for the type-specifier. We use context
3358 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3359 // and if so, whether it is the first decl.
3360 if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3361 if (!cxcursor::isFirstInDeclGroup(C))
3362 Loc = VD->getLocation();
3363 }
3364
Douglas Gregor2ca54fe2010-03-22 15:53:50 +00003365 return cxloc::translateSourceLocation(getCursorContext(C), Loc);
Douglas Gregor98258af2010-01-18 22:46:11 +00003366}
Douglas Gregora7bde202010-01-19 00:34:46 +00003367
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003368} // end extern "C"
3369
3370static SourceRange getRawCursorExtent(CXCursor C) {
Douglas Gregora7bde202010-01-19 00:34:46 +00003371 if (clang_isReference(C.kind)) {
3372 switch (C.kind) {
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003373 case CXCursor_ObjCSuperClassRef:
3374 return getCursorObjCSuperClassRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003375
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003376 case CXCursor_ObjCProtocolRef:
3377 return getCursorObjCProtocolRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003378
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003379 case CXCursor_ObjCClassRef:
3380 return getCursorObjCClassRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003381
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003382 case CXCursor_TypeRef:
3383 return getCursorTypeRef(C).second;
Douglas Gregor0b36e612010-08-31 20:37:03 +00003384
3385 case CXCursor_TemplateRef:
3386 return getCursorTemplateRef(C).second;
3387
Douglas Gregor69319002010-08-31 23:48:11 +00003388 case CXCursor_NamespaceRef:
3389 return getCursorNamespaceRef(C).second;
Douglas Gregora67e03f2010-09-09 21:42:20 +00003390
3391 case CXCursor_MemberRef:
3392 return getCursorMemberRef(C).second;
3393
Ted Kremenek3064ef92010-08-27 21:34:58 +00003394 case CXCursor_CXXBaseSpecifier:
Douglas Gregor1b0f7af2010-10-02 19:51:13 +00003395 return getCursorCXXBaseSpecifier(C)->getSourceRange();
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003396
Douglas Gregor36897b02010-09-10 00:22:18 +00003397 case CXCursor_LabelRef:
3398 return getCursorLabelRef(C).second;
3399
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003400 case CXCursor_OverloadedDeclRef:
3401 return getCursorOverloadedDeclRef(C).second;
3402
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003403 default:
3404 // FIXME: Need a way to enumerate all non-reference cases.
3405 llvm_unreachable("Missed a reference kind");
Douglas Gregora7bde202010-01-19 00:34:46 +00003406 }
3407 }
Douglas Gregor97b98722010-01-19 23:20:36 +00003408
3409 if (clang_isExpression(C.kind))
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003410 return getCursorExpr(C)->getSourceRange();
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003411
3412 if (clang_isStatement(C.kind))
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003413 return getCursorStmt(C)->getSourceRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003414
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003415 if (C.kind == CXCursor_PreprocessingDirective)
3416 return cxcursor::getCursorPreprocessingDirective(C);
Douglas Gregor48072312010-03-18 15:23:44 +00003417
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003418 if (C.kind == CXCursor_MacroInstantiation)
3419 return cxcursor::getCursorMacroInstantiation(C)->getSourceRange();
Douglas Gregor572feb22010-03-18 18:04:21 +00003420
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003421 if (C.kind == CXCursor_MacroDefinition)
3422 return cxcursor::getCursorMacroDefinition(C)->getSourceRange();
Douglas Gregorecdcb882010-10-20 22:00:55 +00003423
3424 if (C.kind == CXCursor_InclusionDirective)
3425 return cxcursor::getCursorInclusionDirective(C)->getSourceRange();
3426
Ted Kremenek007a7c92010-11-01 23:26:51 +00003427 if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl) {
3428 Decl *D = cxcursor::getCursorDecl(C);
3429 SourceRange R = D->getSourceRange();
3430 // FIXME: Multiple variables declared in a single declaration
3431 // currently lack the information needed to correctly determine their
3432 // ranges when accounting for the type-specifier. We use context
3433 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3434 // and if so, whether it is the first decl.
3435 if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3436 if (!cxcursor::isFirstInDeclGroup(C))
3437 R.setBegin(VD->getLocation());
3438 }
3439 return R;
3440 }
Douglas Gregor66537982010-11-17 17:14:07 +00003441 return SourceRange();
3442}
3443
3444/// \brief Retrieves the "raw" cursor extent, which is then extended to include
3445/// the decl-specifier-seq for declarations.
3446static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr) {
3447 if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl) {
3448 Decl *D = cxcursor::getCursorDecl(C);
3449 SourceRange R = D->getSourceRange();
3450
3451 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
3452 if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
3453 TypeLoc TL = TI->getTypeLoc();
3454 SourceLocation TLoc = TL.getSourceRange().getBegin();
3455 if (TLoc.isValid() && R.getBegin().isValid() &&
3456 SrcMgr.isBeforeInTranslationUnit(TLoc, R.getBegin()))
3457 R.setBegin(TLoc);
3458 }
3459
3460 // FIXME: Multiple variables declared in a single declaration
3461 // currently lack the information needed to correctly determine their
3462 // ranges when accounting for the type-specifier. We use context
3463 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3464 // and if so, whether it is the first decl.
3465 if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3466 if (!cxcursor::isFirstInDeclGroup(C))
3467 R.setBegin(VD->getLocation());
3468 }
3469 }
3470
3471 return R;
3472 }
3473
3474 return getRawCursorExtent(C);
3475}
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003476
3477extern "C" {
3478
3479CXSourceRange clang_getCursorExtent(CXCursor C) {
3480 SourceRange R = getRawCursorExtent(C);
3481 if (R.isInvalid())
Douglas Gregor5352ac02010-01-28 00:27:43 +00003482 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003483
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003484 return cxloc::translateSourceRange(getCursorContext(C), R);
Douglas Gregora7bde202010-01-19 00:34:46 +00003485}
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003486
3487CXCursor clang_getCursorReferenced(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003488 if (clang_isInvalid(C.kind))
3489 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003490
Ted Kremeneka60ed472010-11-16 08:15:36 +00003491 CXTranslationUnit tu = getCursorTU(C);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003492 if (clang_isDeclaration(C.kind)) {
3493 Decl *D = getCursorDecl(C);
3494 if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003495 return MakeCursorOverloadedDeclRef(Using, D->getLocation(), tu);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003496 if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003497 return MakeCursorOverloadedDeclRef(Classes, D->getLocation(), tu);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003498 if (ObjCForwardProtocolDecl *Protocols
3499 = dyn_cast<ObjCForwardProtocolDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003500 return MakeCursorOverloadedDeclRef(Protocols, D->getLocation(), tu);
Douglas Gregore3c60a72010-11-17 00:13:31 +00003501 if (ObjCPropertyImplDecl *PropImpl =llvm::dyn_cast<ObjCPropertyImplDecl>(D))
3502 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
3503 return MakeCXCursor(Property, tu);
3504
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003505 return C;
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003506 }
3507
Douglas Gregor97b98722010-01-19 23:20:36 +00003508 if (clang_isExpression(C.kind)) {
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003509 Expr *E = getCursorExpr(C);
3510 Decl *D = getDeclFromExpr(E);
Douglas Gregor97b98722010-01-19 23:20:36 +00003511 if (D)
Ted Kremeneka60ed472010-11-16 08:15:36 +00003512 return MakeCXCursor(D, tu);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003513
3514 if (OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003515 return MakeCursorOverloadedDeclRef(Ovl, tu);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003516
Douglas Gregor97b98722010-01-19 23:20:36 +00003517 return clang_getNullCursor();
3518 }
3519
Douglas Gregor36897b02010-09-10 00:22:18 +00003520 if (clang_isStatement(C.kind)) {
3521 Stmt *S = getCursorStmt(C);
3522 if (GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003523 return MakeCXCursor(Goto->getLabel(), getCursorDecl(C), tu);
Douglas Gregor36897b02010-09-10 00:22:18 +00003524
3525 return clang_getNullCursor();
3526 }
3527
Douglas Gregorbf7efa22010-03-18 18:23:03 +00003528 if (C.kind == CXCursor_MacroInstantiation) {
3529 if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003530 return MakeMacroDefinitionCursor(Def, tu);
Douglas Gregorbf7efa22010-03-18 18:23:03 +00003531 }
3532
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003533 if (!clang_isReference(C.kind))
3534 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003535
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003536 switch (C.kind) {
3537 case CXCursor_ObjCSuperClassRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003538 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, tu);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003539
3540 case CXCursor_ObjCProtocolRef: {
Ted Kremeneka60ed472010-11-16 08:15:36 +00003541 return MakeCXCursor(getCursorObjCProtocolRef(C).first, tu);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003542
3543 case CXCursor_ObjCClassRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003544 return MakeCXCursor(getCursorObjCClassRef(C).first, tu );
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003545
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003546 case CXCursor_TypeRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003547 return MakeCXCursor(getCursorTypeRef(C).first, tu );
Douglas Gregor0b36e612010-08-31 20:37:03 +00003548
3549 case CXCursor_TemplateRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003550 return MakeCXCursor(getCursorTemplateRef(C).first, tu );
Douglas Gregor0b36e612010-08-31 20:37:03 +00003551
Douglas Gregor69319002010-08-31 23:48:11 +00003552 case CXCursor_NamespaceRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003553 return MakeCXCursor(getCursorNamespaceRef(C).first, tu );
Douglas Gregor69319002010-08-31 23:48:11 +00003554
Douglas Gregora67e03f2010-09-09 21:42:20 +00003555 case CXCursor_MemberRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003556 return MakeCXCursor(getCursorMemberRef(C).first, tu );
Douglas Gregora67e03f2010-09-09 21:42:20 +00003557
Ted Kremenek3064ef92010-08-27 21:34:58 +00003558 case CXCursor_CXXBaseSpecifier: {
3559 CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
3560 return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003561 tu ));
Ted Kremenek3064ef92010-08-27 21:34:58 +00003562 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003563
Douglas Gregor36897b02010-09-10 00:22:18 +00003564 case CXCursor_LabelRef:
3565 // FIXME: We end up faking the "parent" declaration here because we
3566 // don't want to make CXCursor larger.
3567 return MakeCXCursor(getCursorLabelRef(C).first,
Ted Kremeneka60ed472010-11-16 08:15:36 +00003568 static_cast<ASTUnit*>(tu->TUData)->getASTContext()
3569 .getTranslationUnitDecl(),
3570 tu);
Douglas Gregor36897b02010-09-10 00:22:18 +00003571
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003572 case CXCursor_OverloadedDeclRef:
3573 return C;
3574
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003575 default:
3576 // We would prefer to enumerate all non-reference cursor kinds here.
3577 llvm_unreachable("Unhandled reference cursor kind");
3578 break;
3579 }
3580 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003581
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003582 return clang_getNullCursor();
3583}
3584
Douglas Gregorb6998662010-01-19 19:34:47 +00003585CXCursor clang_getCursorDefinition(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003586 if (clang_isInvalid(C.kind))
3587 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003588
Ted Kremeneka60ed472010-11-16 08:15:36 +00003589 CXTranslationUnit TU = getCursorTU(C);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003590
Douglas Gregorb6998662010-01-19 19:34:47 +00003591 bool WasReference = false;
Douglas Gregor97b98722010-01-19 23:20:36 +00003592 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
Douglas Gregorb6998662010-01-19 19:34:47 +00003593 C = clang_getCursorReferenced(C);
3594 WasReference = true;
3595 }
3596
Douglas Gregorbf7efa22010-03-18 18:23:03 +00003597 if (C.kind == CXCursor_MacroInstantiation)
3598 return clang_getCursorReferenced(C);
3599
Douglas Gregorb6998662010-01-19 19:34:47 +00003600 if (!clang_isDeclaration(C.kind))
3601 return clang_getNullCursor();
3602
3603 Decl *D = getCursorDecl(C);
3604 if (!D)
3605 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003606
Douglas Gregorb6998662010-01-19 19:34:47 +00003607 switch (D->getKind()) {
3608 // Declaration kinds that don't really separate the notions of
3609 // declaration and definition.
3610 case Decl::Namespace:
3611 case Decl::Typedef:
3612 case Decl::TemplateTypeParm:
3613 case Decl::EnumConstant:
3614 case Decl::Field:
Benjamin Kramerd9811462010-11-21 14:11:41 +00003615 case Decl::IndirectField:
Douglas Gregorb6998662010-01-19 19:34:47 +00003616 case Decl::ObjCIvar:
3617 case Decl::ObjCAtDefsField:
3618 case Decl::ImplicitParam:
3619 case Decl::ParmVar:
3620 case Decl::NonTypeTemplateParm:
3621 case Decl::TemplateTemplateParm:
3622 case Decl::ObjCCategoryImpl:
3623 case Decl::ObjCImplementation:
Abramo Bagnara6206d532010-06-05 05:09:32 +00003624 case Decl::AccessSpec:
Douglas Gregorb6998662010-01-19 19:34:47 +00003625 case Decl::LinkageSpec:
3626 case Decl::ObjCPropertyImpl:
3627 case Decl::FileScopeAsm:
3628 case Decl::StaticAssert:
3629 case Decl::Block:
3630 return C;
3631
3632 // Declaration kinds that don't make any sense here, but are
3633 // nonetheless harmless.
3634 case Decl::TranslationUnit:
Douglas Gregorb6998662010-01-19 19:34:47 +00003635 break;
3636
3637 // Declaration kinds for which the definition is not resolvable.
3638 case Decl::UnresolvedUsingTypename:
3639 case Decl::UnresolvedUsingValue:
3640 break;
3641
3642 case Decl::UsingDirective:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003643 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003644 TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003645
3646 case Decl::NamespaceAlias:
Ted Kremeneka60ed472010-11-16 08:15:36 +00003647 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003648
3649 case Decl::Enum:
3650 case Decl::Record:
3651 case Decl::CXXRecord:
3652 case Decl::ClassTemplateSpecialization:
3653 case Decl::ClassTemplatePartialSpecialization:
Douglas Gregor952b0172010-02-11 01:04:33 +00003654 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003655 return MakeCXCursor(Def, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003656 return clang_getNullCursor();
3657
3658 case Decl::Function:
3659 case Decl::CXXMethod:
3660 case Decl::CXXConstructor:
3661 case Decl::CXXDestructor:
3662 case Decl::CXXConversion: {
3663 const FunctionDecl *Def = 0;
3664 if (cast<FunctionDecl>(D)->getBody(Def))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003665 return MakeCXCursor(const_cast<FunctionDecl *>(Def), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003666 return clang_getNullCursor();
3667 }
3668
3669 case Decl::Var: {
Sebastian Redl31310a22010-02-01 20:16:42 +00003670 // Ask the variable if it has a definition.
3671 if (VarDecl *Def = cast<VarDecl>(D)->getDefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003672 return MakeCXCursor(Def, TU);
Sebastian Redl31310a22010-02-01 20:16:42 +00003673 return clang_getNullCursor();
Douglas Gregorb6998662010-01-19 19:34:47 +00003674 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003675
Douglas Gregorb6998662010-01-19 19:34:47 +00003676 case Decl::FunctionTemplate: {
3677 const FunctionDecl *Def = 0;
3678 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003679 return MakeCXCursor(Def->getDescribedFunctionTemplate(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003680 return clang_getNullCursor();
3681 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003682
Douglas Gregorb6998662010-01-19 19:34:47 +00003683 case Decl::ClassTemplate: {
3684 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
Douglas Gregor952b0172010-02-11 01:04:33 +00003685 ->getDefinition())
Douglas Gregor0b36e612010-08-31 20:37:03 +00003686 return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003687 TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003688 return clang_getNullCursor();
3689 }
3690
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003691 case Decl::Using:
3692 return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003693 D->getLocation(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003694
3695 case Decl::UsingShadow:
3696 return clang_getCursorDefinition(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003697 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003698 TU));
Douglas Gregorb6998662010-01-19 19:34:47 +00003699
3700 case Decl::ObjCMethod: {
3701 ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
3702 if (Method->isThisDeclarationADefinition())
3703 return C;
3704
3705 // Dig out the method definition in the associated
3706 // @implementation, if we have it.
3707 // FIXME: The ASTs should make finding the definition easier.
3708 if (ObjCInterfaceDecl *Class
3709 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
3710 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
3711 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
3712 Method->isInstanceMethod()))
3713 if (Def->isThisDeclarationADefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003714 return MakeCXCursor(Def, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003715
3716 return clang_getNullCursor();
3717 }
3718
3719 case Decl::ObjCCategory:
3720 if (ObjCCategoryImplDecl *Impl
3721 = cast<ObjCCategoryDecl>(D)->getImplementation())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003722 return MakeCXCursor(Impl, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003723 return clang_getNullCursor();
3724
3725 case Decl::ObjCProtocol:
3726 if (!cast<ObjCProtocolDecl>(D)->isForwardDecl())
3727 return C;
3728 return clang_getNullCursor();
3729
3730 case Decl::ObjCInterface:
3731 // There are two notions of a "definition" for an Objective-C
3732 // class: the interface and its implementation. When we resolved a
3733 // reference to an Objective-C class, produce the @interface as
3734 // the definition; when we were provided with the interface,
3735 // produce the @implementation as the definition.
3736 if (WasReference) {
3737 if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl())
3738 return C;
3739 } else if (ObjCImplementationDecl *Impl
3740 = cast<ObjCInterfaceDecl>(D)->getImplementation())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003741 return MakeCXCursor(Impl, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003742 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003743
Douglas Gregorb6998662010-01-19 19:34:47 +00003744 case Decl::ObjCProperty:
3745 // FIXME: We don't really know where to find the
3746 // ObjCPropertyImplDecls that implement this property.
3747 return clang_getNullCursor();
3748
3749 case Decl::ObjCCompatibleAlias:
3750 if (ObjCInterfaceDecl *Class
3751 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
3752 if (!Class->isForwardDecl())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003753 return MakeCXCursor(Class, TU);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003754
Douglas Gregorb6998662010-01-19 19:34:47 +00003755 return clang_getNullCursor();
3756
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003757 case Decl::ObjCForwardProtocol:
3758 return MakeCursorOverloadedDeclRef(cast<ObjCForwardProtocolDecl>(D),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003759 D->getLocation(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003760
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003761 case Decl::ObjCClass:
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00003762 return MakeCursorOverloadedDeclRef(cast<ObjCClassDecl>(D), D->getLocation(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00003763 TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00003764
3765 case Decl::Friend:
3766 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003767 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
Douglas Gregorb6998662010-01-19 19:34:47 +00003768 return clang_getNullCursor();
3769
3770 case Decl::FriendTemplate:
3771 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003772 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
Douglas Gregorb6998662010-01-19 19:34:47 +00003773 return clang_getNullCursor();
3774 }
3775
3776 return clang_getNullCursor();
3777}
3778
3779unsigned clang_isCursorDefinition(CXCursor C) {
3780 if (!clang_isDeclaration(C.kind))
3781 return 0;
3782
3783 return clang_getCursorDefinition(C) == C;
3784}
3785
Douglas Gregor1a9d0502010-11-19 23:44:15 +00003786CXCursor clang_getCanonicalCursor(CXCursor C) {
3787 if (!clang_isDeclaration(C.kind))
3788 return C;
3789
3790 if (Decl *D = getCursorDecl(C))
3791 return MakeCXCursor(D->getCanonicalDecl(), getCursorTU(C));
3792
3793 return C;
3794}
3795
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003796unsigned clang_getNumOverloadedDecls(CXCursor C) {
Douglas Gregor7c432dd2010-09-16 13:54:00 +00003797 if (C.kind != CXCursor_OverloadedDeclRef)
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003798 return 0;
3799
3800 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
3801 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
3802 return E->getNumDecls();
3803
3804 if (OverloadedTemplateStorage *S
3805 = Storage.dyn_cast<OverloadedTemplateStorage*>())
3806 return S->size();
3807
3808 Decl *D = Storage.get<Decl*>();
3809 if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
Argyrios Kyrtzidis826faa22010-11-10 05:40:41 +00003810 return Using->shadow_size();
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003811 if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
3812 return Classes->size();
3813 if (ObjCForwardProtocolDecl *Protocols =dyn_cast<ObjCForwardProtocolDecl>(D))
3814 return Protocols->protocol_size();
3815
3816 return 0;
3817}
3818
3819CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) {
Douglas Gregor7c432dd2010-09-16 13:54:00 +00003820 if (cursor.kind != CXCursor_OverloadedDeclRef)
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003821 return clang_getNullCursor();
3822
3823 if (index >= clang_getNumOverloadedDecls(cursor))
3824 return clang_getNullCursor();
3825
Ted Kremeneka60ed472010-11-16 08:15:36 +00003826 CXTranslationUnit TU = getCursorTU(cursor);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003827 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first;
3828 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003829 return MakeCXCursor(E->decls_begin()[index], TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003830
3831 if (OverloadedTemplateStorage *S
3832 = Storage.dyn_cast<OverloadedTemplateStorage*>())
Ted Kremeneka60ed472010-11-16 08:15:36 +00003833 return MakeCXCursor(S->begin()[index], TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003834
3835 Decl *D = Storage.get<Decl*>();
3836 if (UsingDecl *Using = dyn_cast<UsingDecl>(D)) {
3837 // FIXME: This is, unfortunately, linear time.
3838 UsingDecl::shadow_iterator Pos = Using->shadow_begin();
3839 std::advance(Pos, index);
Ted Kremeneka60ed472010-11-16 08:15:36 +00003840 return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003841 }
3842
3843 if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003844 return MakeCXCursor(Classes->begin()[index].getInterface(), TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003845
3846 if (ObjCForwardProtocolDecl *Protocols = dyn_cast<ObjCForwardProtocolDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003847 return MakeCXCursor(Protocols->protocol_begin()[index], TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003848
3849 return clang_getNullCursor();
3850}
3851
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00003852void clang_getDefinitionSpellingAndExtent(CXCursor C,
Steve Naroff4ade6d62009-09-23 17:52:52 +00003853 const char **startBuf,
3854 const char **endBuf,
3855 unsigned *startLine,
3856 unsigned *startColumn,
3857 unsigned *endLine,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003858 unsigned *endColumn) {
Douglas Gregor283cae32010-01-15 21:56:13 +00003859 assert(getCursorDecl(C) && "CXCursor has null decl");
3860 NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C));
Steve Naroff4ade6d62009-09-23 17:52:52 +00003861 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
3862 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003863
Steve Naroff4ade6d62009-09-23 17:52:52 +00003864 SourceManager &SM = FD->getASTContext().getSourceManager();
3865 *startBuf = SM.getCharacterData(Body->getLBracLoc());
3866 *endBuf = SM.getCharacterData(Body->getRBracLoc());
3867 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
3868 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
3869 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
3870 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
3871}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003872
Douglas Gregor0a812cf2010-02-18 23:07:20 +00003873void clang_enableStackTraces(void) {
3874 llvm::sys::PrintStackTraceOnErrorSignal();
3875}
3876
Daniel Dunbar995aaf92010-11-04 01:26:29 +00003877void clang_executeOnThread(void (*fn)(void*), void *user_data,
3878 unsigned stack_size) {
3879 llvm::llvm_execute_on_thread(fn, user_data, stack_size);
3880}
3881
Ted Kremenekfb480492010-01-13 21:46:36 +00003882} // end: extern "C"
Steve Naroff4ade6d62009-09-23 17:52:52 +00003883
Ted Kremenekfb480492010-01-13 21:46:36 +00003884//===----------------------------------------------------------------------===//
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003885// Token-based Operations.
3886//===----------------------------------------------------------------------===//
3887
3888/* CXToken layout:
3889 * int_data[0]: a CXTokenKind
3890 * int_data[1]: starting token location
3891 * int_data[2]: token length
3892 * int_data[3]: reserved
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003893 * ptr_data: for identifiers and keywords, an IdentifierInfo*.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003894 * otherwise unused.
3895 */
3896extern "C" {
3897
3898CXTokenKind clang_getTokenKind(CXToken CXTok) {
3899 return static_cast<CXTokenKind>(CXTok.int_data[0]);
3900}
3901
3902CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
3903 switch (clang_getTokenKind(CXTok)) {
3904 case CXToken_Identifier:
3905 case CXToken_Keyword:
3906 // We know we have an IdentifierInfo*, so use that.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003907 return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data)
3908 ->getNameStart());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003909
3910 case CXToken_Literal: {
3911 // We have stashed the starting pointer in the ptr_data field. Use it.
3912 const char *Text = static_cast<const char *>(CXTok.ptr_data);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003913 return createCXString(llvm::StringRef(Text, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003914 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003915
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003916 case CXToken_Punctuation:
3917 case CXToken_Comment:
3918 break;
3919 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003920
3921 // We have to find the starting buffer pointer the hard way, by
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003922 // deconstructing the source location.
Ted Kremeneka60ed472010-11-16 08:15:36 +00003923 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003924 if (!CXXUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003925 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003926
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003927 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
3928 std::pair<FileID, unsigned> LocInfo
3929 = CXXUnit->getSourceManager().getDecomposedLoc(Loc);
Douglas Gregorf715ca12010-03-16 00:06:06 +00003930 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003931 llvm::StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00003932 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
3933 if (Invalid)
Douglas Gregoraea67db2010-03-15 22:54:52 +00003934 return createCXString("");
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003935
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003936 return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003937}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003938
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003939CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
Ted Kremeneka60ed472010-11-16 08:15:36 +00003940 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003941 if (!CXXUnit)
3942 return clang_getNullLocation();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003943
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003944 return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
3945 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3946}
3947
3948CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
Ted Kremeneka60ed472010-11-16 08:15:36 +00003949 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregor5352ac02010-01-28 00:27:43 +00003950 if (!CXXUnit)
3951 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003952
3953 return cxloc::translateSourceRange(CXXUnit->getASTContext(),
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003954 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3955}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003956
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003957void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
3958 CXToken **Tokens, unsigned *NumTokens) {
3959 if (Tokens)
3960 *Tokens = 0;
3961 if (NumTokens)
3962 *NumTokens = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003963
Ted Kremeneka60ed472010-11-16 08:15:36 +00003964 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003965 if (!CXXUnit || !Tokens || !NumTokens)
3966 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003967
Douglas Gregorbdf60622010-03-05 21:16:25 +00003968 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3969
Daniel Dunbar85b988f2010-02-14 08:31:57 +00003970 SourceRange R = cxloc::translateCXSourceRange(Range);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003971 if (R.isInvalid())
3972 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003973
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003974 SourceManager &SourceMgr = CXXUnit->getSourceManager();
3975 std::pair<FileID, unsigned> BeginLocInfo
3976 = SourceMgr.getDecomposedLoc(R.getBegin());
3977 std::pair<FileID, unsigned> EndLocInfo
3978 = SourceMgr.getDecomposedLoc(R.getEnd());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003979
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003980 // Cannot tokenize across files.
3981 if (BeginLocInfo.first != EndLocInfo.first)
3982 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003983
3984 // Create a lexer
Douglas Gregorf715ca12010-03-16 00:06:06 +00003985 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003986 llvm::StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00003987 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
Douglas Gregor47a3fcd2010-03-16 20:26:15 +00003988 if (Invalid)
3989 return;
Douglas Gregoraea67db2010-03-15 22:54:52 +00003990
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003991 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
3992 CXXUnit->getASTContext().getLangOptions(),
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003993 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003994 Lex.SetCommentRetentionState(true);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003995
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003996 // Lex tokens until we hit the end of the range.
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003997 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003998 llvm::SmallVector<CXToken, 32> CXTokens;
3999 Token Tok;
David Chisnall096428b2010-10-13 21:44:48 +00004000 bool previousWasAt = false;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004001 do {
4002 // Lex the next token
4003 Lex.LexFromRawLexer(Tok);
4004 if (Tok.is(tok::eof))
4005 break;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004006
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004007 // Initialize the CXToken.
4008 CXToken CXTok;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004009
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004010 // - Common fields
4011 CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
4012 CXTok.int_data[2] = Tok.getLength();
4013 CXTok.int_data[3] = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004014
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004015 // - Kind-specific fields
4016 if (Tok.isLiteral()) {
4017 CXTok.int_data[0] = CXToken_Literal;
4018 CXTok.ptr_data = (void *)Tok.getLiteralData();
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00004019 } else if (Tok.is(tok::raw_identifier)) {
Douglas Gregoraea67db2010-03-15 22:54:52 +00004020 // Lookup the identifier to determine whether we have a keyword.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004021 IdentifierInfo *II
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00004022 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok);
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00004023
David Chisnall096428b2010-10-13 21:44:48 +00004024 if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) {
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00004025 CXTok.int_data[0] = CXToken_Keyword;
4026 }
4027 else {
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00004028 CXTok.int_data[0] = Tok.is(tok::identifier)
4029 ? CXToken_Identifier
4030 : CXToken_Keyword;
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00004031 }
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004032 CXTok.ptr_data = II;
4033 } else if (Tok.is(tok::comment)) {
4034 CXTok.int_data[0] = CXToken_Comment;
4035 CXTok.ptr_data = 0;
4036 } else {
4037 CXTok.int_data[0] = CXToken_Punctuation;
4038 CXTok.ptr_data = 0;
4039 }
4040 CXTokens.push_back(CXTok);
David Chisnall096428b2010-10-13 21:44:48 +00004041 previousWasAt = Tok.is(tok::at);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004042 } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004043
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004044 if (CXTokens.empty())
4045 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004046
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004047 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
4048 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
4049 *NumTokens = CXTokens.size();
4050}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004051
Ted Kremenek6db61092010-05-05 00:55:15 +00004052void clang_disposeTokens(CXTranslationUnit TU,
4053 CXToken *Tokens, unsigned NumTokens) {
4054 free(Tokens);
4055}
4056
4057} // end: extern "C"
4058
4059//===----------------------------------------------------------------------===//
4060// Token annotation APIs.
4061//===----------------------------------------------------------------------===//
4062
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004063typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004064static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
4065 CXCursor parent,
4066 CXClientData client_data);
Ted Kremenek6db61092010-05-05 00:55:15 +00004067namespace {
4068class AnnotateTokensWorker {
4069 AnnotateTokensData &Annotated;
Ted Kremenek11949cb2010-05-05 00:55:17 +00004070 CXToken *Tokens;
4071 CXCursor *Cursors;
4072 unsigned NumTokens;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004073 unsigned TokIdx;
Douglas Gregor4419b672010-10-21 06:10:04 +00004074 unsigned PreprocessingTokIdx;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004075 CursorVisitor AnnotateVis;
4076 SourceManager &SrcMgr;
4077
4078 bool MoreTokens() const { return TokIdx < NumTokens; }
4079 unsigned NextToken() const { return TokIdx; }
4080 void AdvanceToken() { ++TokIdx; }
4081 SourceLocation GetTokenLoc(unsigned tokI) {
4082 return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]);
4083 }
4084
Ted Kremenek6db61092010-05-05 00:55:15 +00004085public:
Ted Kremenek11949cb2010-05-05 00:55:17 +00004086 AnnotateTokensWorker(AnnotateTokensData &annotated,
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004087 CXToken *tokens, CXCursor *cursors, unsigned numTokens,
Ted Kremeneka60ed472010-11-16 08:15:36 +00004088 CXTranslationUnit tu, SourceRange RegionOfInterest)
Ted Kremenek11949cb2010-05-05 00:55:17 +00004089 : Annotated(annotated), Tokens(tokens), Cursors(cursors),
Douglas Gregor4419b672010-10-21 06:10:04 +00004090 NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004091 AnnotateVis(tu,
4092 AnnotateTokensVisitor, this,
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004093 Decl::MaxPCHLevel, RegionOfInterest),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004094 SrcMgr(static_cast<ASTUnit*>(tu->TUData)->getSourceManager()) {}
Ted Kremenek11949cb2010-05-05 00:55:17 +00004095
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004096 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
Ted Kremenek6db61092010-05-05 00:55:15 +00004097 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004098 void AnnotateTokens(CXCursor parent);
Ted Kremenekab979612010-11-11 08:05:23 +00004099 void AnnotateTokens() {
Ted Kremeneka60ed472010-11-16 08:15:36 +00004100 AnnotateTokens(clang_getTranslationUnitCursor(AnnotateVis.getTU()));
Ted Kremenekab979612010-11-11 08:05:23 +00004101 }
Ted Kremenek6db61092010-05-05 00:55:15 +00004102};
4103}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004104
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004105void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) {
4106 // Walk the AST within the region of interest, annotating tokens
4107 // along the way.
4108 VisitChildren(parent);
Ted Kremenek11949cb2010-05-05 00:55:17 +00004109
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004110 for (unsigned I = 0 ; I < TokIdx ; ++I) {
4111 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
Douglas Gregor4419b672010-10-21 06:10:04 +00004112 if (Pos != Annotated.end() &&
4113 (clang_isInvalid(Cursors[I].kind) ||
4114 Pos->second.kind != CXCursor_PreprocessingDirective))
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004115 Cursors[I] = Pos->second;
4116 }
4117
4118 // Finish up annotating any tokens left.
4119 if (!MoreTokens())
4120 return;
4121
4122 const CXCursor &C = clang_getNullCursor();
4123 for (unsigned I = TokIdx ; I < NumTokens ; ++I) {
4124 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
4125 Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second;
Ted Kremenek11949cb2010-05-05 00:55:17 +00004126 }
4127}
4128
Ted Kremenek6db61092010-05-05 00:55:15 +00004129enum CXChildVisitResult
Douglas Gregor4419b672010-10-21 06:10:04 +00004130AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004131 CXSourceLocation Loc = clang_getCursorLocation(cursor);
Douglas Gregor4419b672010-10-21 06:10:04 +00004132 SourceRange cursorRange = getRawCursorExtent(cursor);
Douglas Gregor81d3c042010-11-01 20:13:04 +00004133 if (cursorRange.isInvalid())
4134 return CXChildVisit_Recurse;
4135
Douglas Gregor4419b672010-10-21 06:10:04 +00004136 if (clang_isPreprocessing(cursor.kind)) {
4137 // For macro instantiations, just note where the beginning of the macro
4138 // instantiation occurs.
4139 if (cursor.kind == CXCursor_MacroInstantiation) {
4140 Annotated[Loc.int_data] = cursor;
4141 return CXChildVisit_Recurse;
4142 }
4143
Douglas Gregor4419b672010-10-21 06:10:04 +00004144 // Items in the preprocessing record are kept separate from items in
4145 // declarations, so we keep a separate token index.
4146 unsigned SavedTokIdx = TokIdx;
4147 TokIdx = PreprocessingTokIdx;
4148
4149 // Skip tokens up until we catch up to the beginning of the preprocessing
4150 // entry.
4151 while (MoreTokens()) {
4152 const unsigned I = NextToken();
4153 SourceLocation TokLoc = GetTokenLoc(I);
4154 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4155 case RangeBefore:
4156 AdvanceToken();
4157 continue;
4158 case RangeAfter:
4159 case RangeOverlap:
4160 break;
4161 }
4162 break;
4163 }
4164
4165 // Look at all of the tokens within this range.
4166 while (MoreTokens()) {
4167 const unsigned I = NextToken();
4168 SourceLocation TokLoc = GetTokenLoc(I);
4169 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4170 case RangeBefore:
4171 assert(0 && "Infeasible");
4172 case RangeAfter:
4173 break;
4174 case RangeOverlap:
4175 Cursors[I] = cursor;
4176 AdvanceToken();
4177 continue;
4178 }
4179 break;
4180 }
4181
4182 // Save the preprocessing token index; restore the non-preprocessing
4183 // token index.
4184 PreprocessingTokIdx = TokIdx;
4185 TokIdx = SavedTokIdx;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004186 return CXChildVisit_Recurse;
4187 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004188
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004189 if (cursorRange.isInvalid())
4190 return CXChildVisit_Continue;
Ted Kremeneka333c662010-05-12 05:29:33 +00004191
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004192 SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data);
4193
Ted Kremeneka333c662010-05-12 05:29:33 +00004194 // Adjust the annotated range based specific declarations.
4195 const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
4196 if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) {
Ted Kremenek23173d72010-05-18 21:09:07 +00004197 Decl *D = cxcursor::getCursorDecl(cursor);
4198 // Don't visit synthesized ObjC methods, since they have no syntatic
4199 // representation in the source.
4200 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
4201 if (MD->isSynthesized())
4202 return CXChildVisit_Continue;
4203 }
4204 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
Ted Kremeneka333c662010-05-12 05:29:33 +00004205 if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
4206 TypeLoc TL = TI->getTypeLoc();
Abramo Bagnarabd054db2010-05-20 10:00:11 +00004207 SourceLocation TLoc = TL.getSourceRange().getBegin();
Douglas Gregor81d3c042010-11-01 20:13:04 +00004208 if (TLoc.isValid() && L.isValid() &&
Ted Kremenek6bfd5332010-05-13 15:38:38 +00004209 SrcMgr.isBeforeInTranslationUnit(TLoc, L))
Ted Kremeneka333c662010-05-12 05:29:33 +00004210 cursorRange.setBegin(TLoc);
Ted Kremeneka333c662010-05-12 05:29:33 +00004211 }
4212 }
4213 }
Douglas Gregor81d3c042010-11-01 20:13:04 +00004214
Ted Kremenek3f404602010-08-14 01:14:06 +00004215 // If the location of the cursor occurs within a macro instantiation, record
4216 // the spelling location of the cursor in our annotation map. We can then
4217 // paper over the token labelings during a post-processing step to try and
4218 // get cursor mappings for tokens that are the *arguments* of a macro
4219 // instantiation.
4220 if (L.isMacroID()) {
4221 unsigned rawEncoding = SrcMgr.getSpellingLoc(L).getRawEncoding();
4222 // Only invalidate the old annotation if it isn't part of a preprocessing
4223 // directive. Here we assume that the default construction of CXCursor
4224 // results in CXCursor.kind being an initialized value (i.e., 0). If
4225 // this isn't the case, we can fix by doing lookup + insertion.
Douglas Gregor4419b672010-10-21 06:10:04 +00004226
Ted Kremenek3f404602010-08-14 01:14:06 +00004227 CXCursor &oldC = Annotated[rawEncoding];
4228 if (!clang_isPreprocessing(oldC.kind))
4229 oldC = cursor;
4230 }
4231
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004232 const enum CXCursorKind K = clang_getCursorKind(parent);
4233 const CXCursor updateC =
Ted Kremenekd8b0a842010-08-25 22:16:02 +00004234 (clang_isInvalid(K) || K == CXCursor_TranslationUnit)
4235 ? clang_getNullCursor() : parent;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004236
4237 while (MoreTokens()) {
4238 const unsigned I = NextToken();
4239 SourceLocation TokLoc = GetTokenLoc(I);
4240 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4241 case RangeBefore:
4242 Cursors[I] = updateC;
4243 AdvanceToken();
4244 continue;
4245 case RangeAfter:
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004246 case RangeOverlap:
4247 break;
4248 }
4249 break;
4250 }
4251
4252 // Visit children to get their cursor information.
4253 const unsigned BeforeChildren = NextToken();
4254 VisitChildren(cursor);
4255 const unsigned AfterChildren = NextToken();
4256
4257 // Adjust 'Last' to the last token within the extent of the cursor.
4258 while (MoreTokens()) {
4259 const unsigned I = NextToken();
4260 SourceLocation TokLoc = GetTokenLoc(I);
4261 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4262 case RangeBefore:
4263 assert(0 && "Infeasible");
4264 case RangeAfter:
4265 break;
4266 case RangeOverlap:
4267 Cursors[I] = updateC;
4268 AdvanceToken();
4269 continue;
4270 }
4271 break;
4272 }
4273 const unsigned Last = NextToken();
Ted Kremenek6db61092010-05-05 00:55:15 +00004274
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004275 // Scan the tokens that are at the beginning of the cursor, but are not
4276 // capture by the child cursors.
4277
4278 // For AST elements within macros, rely on a post-annotate pass to
4279 // to correctly annotate the tokens with cursors. Otherwise we can
4280 // get confusing results of having tokens that map to cursors that really
4281 // are expanded by an instantiation.
4282 if (L.isMacroID())
4283 cursor = clang_getNullCursor();
4284
4285 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
4286 if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
4287 break;
Douglas Gregor4419b672010-10-21 06:10:04 +00004288
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004289 Cursors[I] = cursor;
4290 }
4291 // Scan the tokens that are at the end of the cursor, but are not captured
4292 // but the child cursors.
4293 for (unsigned I = AfterChildren; I != Last; ++I)
4294 Cursors[I] = cursor;
4295
4296 TokIdx = Last;
4297 return CXChildVisit_Continue;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004298}
4299
Ted Kremenek6db61092010-05-05 00:55:15 +00004300static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
4301 CXCursor parent,
4302 CXClientData client_data) {
4303 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
4304}
4305
Ted Kremenekab979612010-11-11 08:05:23 +00004306// This gets run a separate thread to avoid stack blowout.
4307static void runAnnotateTokensWorker(void *UserData) {
4308 ((AnnotateTokensWorker*)UserData)->AnnotateTokens();
4309}
4310
Ted Kremenek6db61092010-05-05 00:55:15 +00004311extern "C" {
4312
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004313void clang_annotateTokens(CXTranslationUnit TU,
4314 CXToken *Tokens, unsigned NumTokens,
4315 CXCursor *Cursors) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004316
4317 if (NumTokens == 0 || !Tokens || !Cursors)
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004318 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004319
Douglas Gregor4419b672010-10-21 06:10:04 +00004320 // Any token we don't specifically annotate will have a NULL cursor.
4321 CXCursor C = clang_getNullCursor();
4322 for (unsigned I = 0; I != NumTokens; ++I)
4323 Cursors[I] = C;
4324
Ted Kremeneka60ed472010-11-16 08:15:36 +00004325 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregor4419b672010-10-21 06:10:04 +00004326 if (!CXXUnit)
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004327 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004328
Douglas Gregorbdf60622010-03-05 21:16:25 +00004329 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004330
Douglas Gregor0396f462010-03-19 05:22:59 +00004331 // Determine the region of interest, which contains all of the tokens.
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004332 SourceRange RegionOfInterest;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004333 RegionOfInterest.setBegin(cxloc::translateSourceLocation(
4334 clang_getTokenLocation(TU, Tokens[0])));
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00004335 RegionOfInterest.setEnd(cxloc::translateSourceLocation(
4336 clang_getTokenLocation(TU,
4337 Tokens[NumTokens - 1])));
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004338
Douglas Gregor0396f462010-03-19 05:22:59 +00004339 // A mapping from the source locations found when re-lexing or traversing the
4340 // region of interest to the corresponding cursors.
4341 AnnotateTokensData Annotated;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004342
4343 // Relex the tokens within the source range to look for preprocessing
Douglas Gregor0396f462010-03-19 05:22:59 +00004344 // directives.
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004345 SourceManager &SourceMgr = CXXUnit->getSourceManager();
4346 std::pair<FileID, unsigned> BeginLocInfo
4347 = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin());
4348 std::pair<FileID, unsigned> EndLocInfo
4349 = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd());
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004350
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004351 llvm::StringRef Buffer;
Douglas Gregor0396f462010-03-19 05:22:59 +00004352 bool Invalid = false;
4353 if (BeginLocInfo.first == EndLocInfo.first &&
4354 ((Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid)),true) &&
4355 !Invalid) {
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004356 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
4357 CXXUnit->getASTContext().getLangOptions(),
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004358 Buffer.begin(), Buffer.data() + BeginLocInfo.second,
Douglas Gregor4ae8f292010-03-18 17:52:52 +00004359 Buffer.end());
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004360 Lex.SetCommentRetentionState(true);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004361
4362 // Lex tokens in raw mode until we hit the end of the range, to avoid
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004363 // entering #includes or expanding macros.
Douglas Gregor48072312010-03-18 15:23:44 +00004364 while (true) {
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004365 Token Tok;
4366 Lex.LexFromRawLexer(Tok);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004367
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004368 reprocess:
4369 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
4370 // We have found a preprocessing directive. Gobble it up so that we
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00004371 // don't see it while preprocessing these tokens later, but keep track
4372 // of all of the token locations inside this preprocessing directive so
4373 // that we can annotate them appropriately.
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004374 //
4375 // FIXME: Some simple tests here could identify macro definitions and
4376 // #undefs, to provide specific cursor kinds for those.
4377 std::vector<SourceLocation> Locations;
4378 do {
4379 Locations.push_back(Tok.getLocation());
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004380 Lex.LexFromRawLexer(Tok);
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004381 } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof));
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004382
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004383 using namespace cxcursor;
4384 CXCursor Cursor
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004385 = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(),
4386 Locations.back()),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004387 TU);
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004388 for (unsigned I = 0, N = Locations.size(); I != N; ++I) {
4389 Annotated[Locations[I].getRawEncoding()] = Cursor;
4390 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004391
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004392 if (Tok.isAtStartOfLine())
4393 goto reprocess;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004394
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004395 continue;
4396 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004397
Douglas Gregor48072312010-03-18 15:23:44 +00004398 if (Tok.is(tok::eof))
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00004399 break;
4400 }
Douglas Gregor4ae8f292010-03-18 17:52:52 +00004401 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004402
Douglas Gregor0396f462010-03-19 05:22:59 +00004403 // Annotate all of the source locations in the region of interest that map to
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004404 // a specific cursor.
4405 AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens,
Ted Kremeneka60ed472010-11-16 08:15:36 +00004406 TU, RegionOfInterest);
Ted Kremenekab979612010-11-11 08:05:23 +00004407
4408 // Run the worker within a CrashRecoveryContext.
Ted Kremenek6c53fdd2010-11-14 17:47:35 +00004409 // FIXME: We use a ridiculous stack size here because the data-recursion
4410 // algorithm uses a large stack frame than the non-data recursive version,
4411 // and AnnotationTokensWorker currently transforms the data-recursion
4412 // algorithm back into a traditional recursion by explicitly calling
4413 // VisitChildren(). We will need to remove this explicit recursive call.
Ted Kremenekab979612010-11-11 08:05:23 +00004414 llvm::CrashRecoveryContext CRC;
Ted Kremenek6c53fdd2010-11-14 17:47:35 +00004415 if (!RunSafely(CRC, runAnnotateTokensWorker, &W,
4416 GetSafetyThreadStackSize() * 2)) {
Ted Kremenekab979612010-11-11 08:05:23 +00004417 fprintf(stderr, "libclang: crash detected while annotating tokens\n");
4418 }
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004419}
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004420} // end: extern "C"
4421
4422//===----------------------------------------------------------------------===//
Ted Kremenek16b42592010-03-03 06:36:57 +00004423// Operations for querying linkage of a cursor.
4424//===----------------------------------------------------------------------===//
4425
4426extern "C" {
4427CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
Douglas Gregor0396f462010-03-19 05:22:59 +00004428 if (!clang_isDeclaration(cursor.kind))
4429 return CXLinkage_Invalid;
4430
Ted Kremenek16b42592010-03-03 06:36:57 +00004431 Decl *D = cxcursor::getCursorDecl(cursor);
4432 if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
4433 switch (ND->getLinkage()) {
4434 case NoLinkage: return CXLinkage_NoLinkage;
4435 case InternalLinkage: return CXLinkage_Internal;
4436 case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
4437 case ExternalLinkage: return CXLinkage_External;
4438 };
4439
4440 return CXLinkage_Invalid;
4441}
4442} // end: extern "C"
4443
4444//===----------------------------------------------------------------------===//
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004445// Operations for querying language of a cursor.
4446//===----------------------------------------------------------------------===//
4447
4448static CXLanguageKind getDeclLanguage(const Decl *D) {
4449 switch (D->getKind()) {
4450 default:
4451 break;
4452 case Decl::ImplicitParam:
4453 case Decl::ObjCAtDefsField:
4454 case Decl::ObjCCategory:
4455 case Decl::ObjCCategoryImpl:
4456 case Decl::ObjCClass:
4457 case Decl::ObjCCompatibleAlias:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004458 case Decl::ObjCForwardProtocol:
4459 case Decl::ObjCImplementation:
4460 case Decl::ObjCInterface:
4461 case Decl::ObjCIvar:
4462 case Decl::ObjCMethod:
4463 case Decl::ObjCProperty:
4464 case Decl::ObjCPropertyImpl:
4465 case Decl::ObjCProtocol:
4466 return CXLanguage_ObjC;
4467 case Decl::CXXConstructor:
4468 case Decl::CXXConversion:
4469 case Decl::CXXDestructor:
4470 case Decl::CXXMethod:
4471 case Decl::CXXRecord:
4472 case Decl::ClassTemplate:
4473 case Decl::ClassTemplatePartialSpecialization:
4474 case Decl::ClassTemplateSpecialization:
4475 case Decl::Friend:
4476 case Decl::FriendTemplate:
4477 case Decl::FunctionTemplate:
4478 case Decl::LinkageSpec:
4479 case Decl::Namespace:
4480 case Decl::NamespaceAlias:
4481 case Decl::NonTypeTemplateParm:
4482 case Decl::StaticAssert:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004483 case Decl::TemplateTemplateParm:
4484 case Decl::TemplateTypeParm:
4485 case Decl::UnresolvedUsingTypename:
4486 case Decl::UnresolvedUsingValue:
4487 case Decl::Using:
4488 case Decl::UsingDirective:
4489 case Decl::UsingShadow:
4490 return CXLanguage_CPlusPlus;
4491 }
4492
4493 return CXLanguage_C;
4494}
4495
4496extern "C" {
Douglas Gregor58ddb602010-08-23 23:00:57 +00004497
4498enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
4499 if (clang_isDeclaration(cursor.kind))
4500 if (Decl *D = cxcursor::getCursorDecl(cursor)) {
4501 if (D->hasAttr<UnavailableAttr>() ||
4502 (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted()))
4503 return CXAvailability_Available;
4504
4505 if (D->hasAttr<DeprecatedAttr>())
4506 return CXAvailability_Deprecated;
4507 }
4508
4509 return CXAvailability_Available;
4510}
4511
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004512CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
4513 if (clang_isDeclaration(cursor.kind))
4514 return getDeclLanguage(cxcursor::getCursorDecl(cursor));
4515
4516 return CXLanguage_Invalid;
4517}
Douglas Gregor3910cfd2010-12-21 07:55:45 +00004518
4519 /// \brief If the given cursor is the "templated" declaration
4520 /// descibing a class or function template, return the class or
4521 /// function template.
4522static Decl *maybeGetTemplateCursor(Decl *D) {
4523 if (!D)
4524 return 0;
4525
4526 if (FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
4527 if (FunctionTemplateDecl *FunTmpl = FD->getDescribedFunctionTemplate())
4528 return FunTmpl;
4529
4530 if (CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D))
4531 if (ClassTemplateDecl *ClassTmpl = RD->getDescribedClassTemplate())
4532 return ClassTmpl;
4533
4534 return D;
4535}
4536
Douglas Gregor2be5bc92010-09-22 21:22:29 +00004537CXCursor clang_getCursorSemanticParent(CXCursor cursor) {
4538 if (clang_isDeclaration(cursor.kind)) {
4539 if (Decl *D = getCursorDecl(cursor)) {
4540 DeclContext *DC = D->getDeclContext();
Douglas Gregor3910cfd2010-12-21 07:55:45 +00004541 if (!DC)
4542 return clang_getNullCursor();
4543
4544 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
4545 getCursorTU(cursor));
Douglas Gregor2be5bc92010-09-22 21:22:29 +00004546 }
4547 }
4548
4549 if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) {
4550 if (Decl *D = getCursorDecl(cursor))
Ted Kremeneka60ed472010-11-16 08:15:36 +00004551 return MakeCXCursor(D, getCursorTU(cursor));
Douglas Gregor2be5bc92010-09-22 21:22:29 +00004552 }
4553
4554 return clang_getNullCursor();
4555}
4556
4557CXCursor clang_getCursorLexicalParent(CXCursor cursor) {
4558 if (clang_isDeclaration(cursor.kind)) {
4559 if (Decl *D = getCursorDecl(cursor)) {
4560 DeclContext *DC = D->getLexicalDeclContext();
Douglas Gregor3910cfd2010-12-21 07:55:45 +00004561 if (!DC)
4562 return clang_getNullCursor();
4563
4564 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
4565 getCursorTU(cursor));
Douglas Gregor2be5bc92010-09-22 21:22:29 +00004566 }
4567 }
4568
4569 // FIXME: Note that we can't easily compute the lexical context of a
4570 // statement or expression, so we return nothing.
4571 return clang_getNullCursor();
4572}
4573
Douglas Gregor9f592342010-10-01 20:25:15 +00004574static void CollectOverriddenMethods(DeclContext *Ctx,
4575 ObjCMethodDecl *Method,
4576 llvm::SmallVectorImpl<ObjCMethodDecl *> &Methods) {
4577 if (!Ctx)
4578 return;
4579
4580 // If we have a class or category implementation, jump straight to the
4581 // interface.
4582 if (ObjCImplDecl *Impl = dyn_cast<ObjCImplDecl>(Ctx))
4583 return CollectOverriddenMethods(Impl->getClassInterface(), Method, Methods);
4584
4585 ObjCContainerDecl *Container = dyn_cast<ObjCContainerDecl>(Ctx);
4586 if (!Container)
4587 return;
4588
4589 // Check whether we have a matching method at this level.
4590 if (ObjCMethodDecl *Overridden = Container->getMethod(Method->getSelector(),
4591 Method->isInstanceMethod()))
4592 if (Method != Overridden) {
4593 // We found an override at this level; there is no need to look
4594 // into other protocols or categories.
4595 Methods.push_back(Overridden);
4596 return;
4597 }
4598
4599 if (ObjCProtocolDecl *Protocol = dyn_cast<ObjCProtocolDecl>(Container)) {
4600 for (ObjCProtocolDecl::protocol_iterator P = Protocol->protocol_begin(),
4601 PEnd = Protocol->protocol_end();
4602 P != PEnd; ++P)
4603 CollectOverriddenMethods(*P, Method, Methods);
4604 }
4605
4606 if (ObjCCategoryDecl *Category = dyn_cast<ObjCCategoryDecl>(Container)) {
4607 for (ObjCCategoryDecl::protocol_iterator P = Category->protocol_begin(),
4608 PEnd = Category->protocol_end();
4609 P != PEnd; ++P)
4610 CollectOverriddenMethods(*P, Method, Methods);
4611 }
4612
4613 if (ObjCInterfaceDecl *Interface = dyn_cast<ObjCInterfaceDecl>(Container)) {
4614 for (ObjCInterfaceDecl::protocol_iterator P = Interface->protocol_begin(),
4615 PEnd = Interface->protocol_end();
4616 P != PEnd; ++P)
4617 CollectOverriddenMethods(*P, Method, Methods);
4618
4619 for (ObjCCategoryDecl *Category = Interface->getCategoryList();
4620 Category; Category = Category->getNextClassCategory())
4621 CollectOverriddenMethods(Category, Method, Methods);
4622
4623 // We only look into the superclass if we haven't found anything yet.
4624 if (Methods.empty())
4625 if (ObjCInterfaceDecl *Super = Interface->getSuperClass())
4626 return CollectOverriddenMethods(Super, Method, Methods);
4627 }
4628}
4629
4630void clang_getOverriddenCursors(CXCursor cursor,
4631 CXCursor **overridden,
4632 unsigned *num_overridden) {
4633 if (overridden)
4634 *overridden = 0;
4635 if (num_overridden)
4636 *num_overridden = 0;
4637 if (!overridden || !num_overridden)
4638 return;
4639
4640 if (!clang_isDeclaration(cursor.kind))
4641 return;
4642
4643 Decl *D = getCursorDecl(cursor);
4644 if (!D)
4645 return;
4646
4647 // Handle C++ member functions.
Ted Kremeneka60ed472010-11-16 08:15:36 +00004648 CXTranslationUnit TU = getCursorTU(cursor);
Douglas Gregor9f592342010-10-01 20:25:15 +00004649 if (CXXMethodDecl *CXXMethod = dyn_cast<CXXMethodDecl>(D)) {
4650 *num_overridden = CXXMethod->size_overridden_methods();
4651 if (!*num_overridden)
4652 return;
4653
4654 *overridden = new CXCursor [*num_overridden];
4655 unsigned I = 0;
4656 for (CXXMethodDecl::method_iterator
4657 M = CXXMethod->begin_overridden_methods(),
4658 MEnd = CXXMethod->end_overridden_methods();
4659 M != MEnd; (void)++M, ++I)
Ted Kremeneka60ed472010-11-16 08:15:36 +00004660 (*overridden)[I] = MakeCXCursor(const_cast<CXXMethodDecl*>(*M), TU);
Douglas Gregor9f592342010-10-01 20:25:15 +00004661 return;
4662 }
4663
4664 ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D);
4665 if (!Method)
4666 return;
4667
4668 // Handle Objective-C methods.
4669 llvm::SmallVector<ObjCMethodDecl *, 4> Methods;
4670 CollectOverriddenMethods(Method->getDeclContext(), Method, Methods);
4671
4672 if (Methods.empty())
4673 return;
4674
4675 *num_overridden = Methods.size();
4676 *overridden = new CXCursor [Methods.size()];
4677 for (unsigned I = 0, N = Methods.size(); I != N; ++I)
Ted Kremeneka60ed472010-11-16 08:15:36 +00004678 (*overridden)[I] = MakeCXCursor(Methods[I], TU);
Douglas Gregor9f592342010-10-01 20:25:15 +00004679}
4680
4681void clang_disposeOverriddenCursors(CXCursor *overridden) {
4682 delete [] overridden;
4683}
4684
Douglas Gregorecdcb882010-10-20 22:00:55 +00004685CXFile clang_getIncludedFile(CXCursor cursor) {
4686 if (cursor.kind != CXCursor_InclusionDirective)
4687 return 0;
4688
4689 InclusionDirective *ID = getCursorInclusionDirective(cursor);
4690 return (void *)ID->getFile();
4691}
4692
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004693} // end: extern "C"
4694
Ted Kremenek9ada39a2010-05-17 20:06:56 +00004695
4696//===----------------------------------------------------------------------===//
4697// C++ AST instrospection.
4698//===----------------------------------------------------------------------===//
4699
4700extern "C" {
4701unsigned clang_CXXMethod_isStatic(CXCursor C) {
4702 if (!clang_isDeclaration(C.kind))
4703 return 0;
Douglas Gregor49f6f542010-08-31 22:12:17 +00004704
4705 CXXMethodDecl *Method = 0;
4706 Decl *D = cxcursor::getCursorDecl(C);
4707 if (FunctionTemplateDecl *FunTmpl = dyn_cast_or_null<FunctionTemplateDecl>(D))
4708 Method = dyn_cast<CXXMethodDecl>(FunTmpl->getTemplatedDecl());
4709 else
4710 Method = dyn_cast_or_null<CXXMethodDecl>(D);
4711 return (Method && Method->isStatic()) ? 1 : 0;
Ted Kremenek40b492a2010-05-17 20:12:45 +00004712}
Ted Kremenekb12903e2010-05-18 22:32:15 +00004713
Ted Kremenek9ada39a2010-05-17 20:06:56 +00004714} // end: extern "C"
4715
Ted Kremenek45e1dae2010-04-12 21:22:16 +00004716//===----------------------------------------------------------------------===//
Ted Kremenek95f33552010-08-26 01:42:22 +00004717// Attribute introspection.
4718//===----------------------------------------------------------------------===//
4719
4720extern "C" {
4721CXType clang_getIBOutletCollectionType(CXCursor C) {
4722 if (C.kind != CXCursor_IBOutletCollectionAttr)
Ted Kremeneka60ed472010-11-16 08:15:36 +00004723 return cxtype::MakeCXType(QualType(), cxcursor::getCursorTU(C));
Ted Kremenek95f33552010-08-26 01:42:22 +00004724
4725 IBOutletCollectionAttr *A =
4726 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
4727
Ted Kremeneka60ed472010-11-16 08:15:36 +00004728 return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorTU(C));
Ted Kremenek95f33552010-08-26 01:42:22 +00004729}
4730} // end: extern "C"
4731
4732//===----------------------------------------------------------------------===//
Ted Kremenek04bb7162010-01-22 22:44:15 +00004733// Misc. utility functions.
4734//===----------------------------------------------------------------------===//
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004735
Daniel Dunbarabdce7a2010-11-05 17:21:46 +00004736/// Default to using an 8 MB stack size on "safety" threads.
4737static unsigned SafetyStackThreadSize = 8 << 20;
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00004738
4739namespace clang {
4740
4741bool RunSafely(llvm::CrashRecoveryContext &CRC,
Ted Kremenek6c53fdd2010-11-14 17:47:35 +00004742 void (*Fn)(void*), void *UserData,
4743 unsigned Size) {
4744 if (!Size)
4745 Size = GetSafetyThreadStackSize();
4746 if (Size)
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00004747 return CRC.RunSafelyOnThread(Fn, UserData, Size);
4748 return CRC.RunSafely(Fn, UserData);
4749}
4750
4751unsigned GetSafetyThreadStackSize() {
4752 return SafetyStackThreadSize;
4753}
4754
4755void SetSafetyThreadStackSize(unsigned Value) {
4756 SafetyStackThreadSize = Value;
4757}
4758
4759}
4760
Ted Kremenek04bb7162010-01-22 22:44:15 +00004761extern "C" {
4762
Ted Kremeneka2a9d6e2010-02-12 22:54:40 +00004763CXString clang_getClangVersion() {
Ted Kremenekee4db4f2010-02-17 00:41:08 +00004764 return createCXString(getClangFullVersion());
Ted Kremenek04bb7162010-01-22 22:44:15 +00004765}
4766
4767} // end: extern "C"