blob: e19cd4214f4cace0b9ab6566bf1416280118d2b5 [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 Kremeneka297de22010-01-25 22:34:44 +000017#include "CXSourceLocation.h"
Douglas Gregor5352ac02010-01-28 00:27:43 +000018#include "CIndexDiagnostic.h"
Ted Kremenekab188932010-01-05 19:32:54 +000019
Ted Kremenek04bb7162010-01-22 22:44:15 +000020#include "clang/Basic/Version.h"
Douglas Gregor936ea3b2010-01-28 00:56:43 +000021
Steve Naroff50398192009-08-28 15:28:48 +000022#include "clang/AST/DeclVisitor.h"
Steve Narofffb570422009-09-22 19:25:29 +000023#include "clang/AST/StmtVisitor.h"
Douglas Gregor7d0d40e2010-01-21 16:28:34 +000024#include "clang/AST/TypeLocVisitor.h"
Benjamin Kramerb846deb2010-04-12 19:45:50 +000025#include "clang/Basic/Diagnostic.h"
26#include "clang/Frontend/ASTUnit.h"
27#include "clang/Frontend/CompilerInstance.h"
Douglas Gregor936ea3b2010-01-28 00:56:43 +000028#include "clang/Frontend/FrontendDiagnostic.h"
Ted Kremenekd8210652010-01-06 23:43:31 +000029#include "clang/Lex/Lexer.h"
Benjamin Kramerb846deb2010-04-12 19:45:50 +000030#include "clang/Lex/PreprocessingRecord.h"
Douglas Gregor33e9abd2010-01-22 19:49:59 +000031#include "clang/Lex/Preprocessor.h"
Douglas Gregor02465752009-10-16 21:24:31 +000032#include "llvm/Support/MemoryBuffer.h"
Benjamin Kramer0829a832009-10-18 11:19:36 +000033#include "llvm/System/Program.h"
Douglas Gregor0a812cf2010-02-18 23:07:20 +000034#include "llvm/System/Signals.h"
Ted Kremenekfc062212009-10-19 21:44:57 +000035
Benjamin Kramerc2a98162010-03-13 21:22:49 +000036// Needed to define L_TMPNAM on some systems.
37#include <cstdio>
38
Steve Naroff50398192009-08-28 15:28:48 +000039using namespace clang;
Ted Kremenek16c440a2010-01-15 20:35:54 +000040using namespace clang::cxcursor;
Ted Kremenekee4db4f2010-02-17 00:41:08 +000041using namespace clang::cxstring;
Steve Naroff50398192009-08-28 15:28:48 +000042
Ted Kremenek8a8da7d2010-01-06 03:42:32 +000043//===----------------------------------------------------------------------===//
44// Crash Reporting.
45//===----------------------------------------------------------------------===//
46
Ted Kremenekd7ffd082010-05-22 00:06:46 +000047#ifdef USE_CRASHTRACER
Ted Kremenek8a8da7d2010-01-06 03:42:32 +000048#include "clang/Analysis/Support/SaveAndRestore.h"
49// Integrate with crash reporter.
Daniel Dunbar439794e2010-05-20 23:50:23 +000050static const char *__crashreporter_info__ = 0;
51asm(".desc ___crashreporter_info__, 0x10");
Ted Kremenek6b569992010-02-17 21:12:23 +000052#define NUM_CRASH_STRINGS 32
Ted Kremenek29b72842010-01-07 22:49:05 +000053static unsigned crashtracer_counter = 0;
Ted Kremenek254ba7c2010-01-07 23:13:53 +000054static unsigned crashtracer_counter_id[NUM_CRASH_STRINGS] = { 0 };
Ted Kremenek29b72842010-01-07 22:49:05 +000055static const char *crashtracer_strings[NUM_CRASH_STRINGS] = { 0 };
56static const char *agg_crashtracer_strings[NUM_CRASH_STRINGS] = { 0 };
57
58static unsigned SetCrashTracerInfo(const char *str,
59 llvm::SmallString<1024> &AggStr) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +000060
Ted Kremenek254ba7c2010-01-07 23:13:53 +000061 unsigned slot = 0;
Ted Kremenek29b72842010-01-07 22:49:05 +000062 while (crashtracer_strings[slot]) {
63 if (++slot == NUM_CRASH_STRINGS)
64 slot = 0;
65 }
66 crashtracer_strings[slot] = str;
Ted Kremenek254ba7c2010-01-07 23:13:53 +000067 crashtracer_counter_id[slot] = ++crashtracer_counter;
Ted Kremenek29b72842010-01-07 22:49:05 +000068
69 // We need to create an aggregate string because multiple threads
70 // may be in this method at one time. The crash reporter string
71 // will attempt to overapproximate the set of in-flight invocations
72 // of this function. Race conditions can still cause this goal
73 // to not be achieved.
74 {
Ted Kremenekf0e23e82010-02-17 00:41:40 +000075 llvm::raw_svector_ostream Out(AggStr);
Ted Kremenek29b72842010-01-07 22:49:05 +000076 for (unsigned i = 0; i < NUM_CRASH_STRINGS; ++i)
77 if (crashtracer_strings[i]) Out << crashtracer_strings[i] << '\n';
78 }
79 __crashreporter_info__ = agg_crashtracer_strings[slot] = AggStr.c_str();
80 return slot;
81}
82
83static void ResetCrashTracerInfo(unsigned slot) {
Ted Kremenek254ba7c2010-01-07 23:13:53 +000084 unsigned max_slot = 0;
85 unsigned max_value = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +000086
Ted Kremenek254ba7c2010-01-07 23:13:53 +000087 crashtracer_strings[slot] = agg_crashtracer_strings[slot] = 0;
88
89 for (unsigned i = 0 ; i < NUM_CRASH_STRINGS; ++i)
90 if (agg_crashtracer_strings[i] &&
91 crashtracer_counter_id[i] > max_value) {
92 max_slot = i;
93 max_value = crashtracer_counter_id[i];
Ted Kremenek29b72842010-01-07 22:49:05 +000094 }
Ted Kremenek254ba7c2010-01-07 23:13:53 +000095
96 __crashreporter_info__ = agg_crashtracer_strings[max_slot];
Ted Kremenek29b72842010-01-07 22:49:05 +000097}
98
99namespace {
100class ArgsCrashTracerInfo {
101 llvm::SmallString<1024> CrashString;
102 llvm::SmallString<1024> AggregateString;
103 unsigned crashtracerSlot;
104public:
105 ArgsCrashTracerInfo(llvm::SmallVectorImpl<const char*> &Args)
106 : crashtracerSlot(0)
107 {
108 {
109 llvm::raw_svector_ostream Out(CrashString);
Ted Kremenek0baa9522010-03-05 22:43:25 +0000110 Out << "ClangCIndex [" << getClangFullVersion() << "]"
111 << "[createTranslationUnitFromSourceFile]: clang";
Ted Kremenek29b72842010-01-07 22:49:05 +0000112 for (llvm::SmallVectorImpl<const char*>::iterator I=Args.begin(),
113 E=Args.end(); I!=E; ++I)
114 Out << ' ' << *I;
115 }
116 crashtracerSlot = SetCrashTracerInfo(CrashString.c_str(),
117 AggregateString);
118 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000119
Ted Kremenek29b72842010-01-07 22:49:05 +0000120 ~ArgsCrashTracerInfo() {
121 ResetCrashTracerInfo(crashtracerSlot);
122 }
123};
124}
125#endif
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000126
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000127/// \brief The result of comparing two source ranges.
128enum RangeComparisonResult {
129 /// \brief Either the ranges overlap or one of the ranges is invalid.
130 RangeOverlap,
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000131
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000132 /// \brief The first range ends before the second range starts.
133 RangeBefore,
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000134
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000135 /// \brief The first range starts after the second range ends.
136 RangeAfter
137};
138
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000139/// \brief Compare two source ranges to determine their relative position in
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000140/// the translation unit.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000141static RangeComparisonResult RangeCompare(SourceManager &SM,
142 SourceRange R1,
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000143 SourceRange R2) {
144 assert(R1.isValid() && "First range is invalid?");
145 assert(R2.isValid() && "Second range is invalid?");
Daniel Dunbard52864b2010-02-14 10:02:57 +0000146 if (R1.getEnd() == R2.getBegin() ||
147 SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000148 return RangeBefore;
Daniel Dunbard52864b2010-02-14 10:02:57 +0000149 if (R2.getEnd() == R1.getBegin() ||
150 SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin()))
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000151 return RangeAfter;
152 return RangeOverlap;
153}
154
Ted Kremenekfbd84ca2010-05-05 00:55:23 +0000155/// \brief Determine if a source location falls within, before, or after a
156/// a given source range.
157static RangeComparisonResult LocationCompare(SourceManager &SM,
158 SourceLocation L, SourceRange R) {
159 assert(R.isValid() && "First range is invalid?");
160 assert(L.isValid() && "Second range is invalid?");
161 if (L == R.getBegin())
162 return RangeOverlap;
163 if (L == R.getEnd())
164 return RangeAfter;
165 if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
166 return RangeBefore;
167 if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
168 return RangeAfter;
169 return RangeOverlap;
170}
171
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000172/// \brief Translate a Clang source range into a CIndex source range.
173///
174/// Clang internally represents ranges where the end location points to the
175/// start of the token at the end. However, for external clients it is more
176/// useful to have a CXSourceRange be a proper half-open interval. This routine
177/// does the appropriate translation.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000178CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000179 const LangOptions &LangOpts,
Chris Lattner0a76aae2010-06-18 22:45:06 +0000180 const CharSourceRange &R) {
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000181 // We want the last character in this location, so we will adjust the
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000182 // location accordingly.
183 // FIXME: How do do this with a macro instantiation location?
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000184 SourceLocation EndLoc = R.getEnd();
Chris Lattner0a76aae2010-06-18 22:45:06 +0000185 if (R.isTokenRange() && !EndLoc.isInvalid() && EndLoc.isFileID()) {
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000186 unsigned Length = Lexer::MeasureTokenLength(EndLoc, SM, LangOpts);
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000187 EndLoc = EndLoc.getFileLocWithOffset(Length);
188 }
189
190 CXSourceRange Result = { { (void *)&SM, (void *)&LangOpts },
191 R.getBegin().getRawEncoding(),
192 EndLoc.getRawEncoding() };
193 return Result;
194}
Douglas Gregor1db19de2010-01-19 21:36:55 +0000195
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000196//===----------------------------------------------------------------------===//
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000197// Cursor visitor.
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000198//===----------------------------------------------------------------------===//
199
Steve Naroff89922f82009-08-31 00:59:03 +0000200namespace {
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000201
Douglas Gregorb1373d02010-01-20 20:59:29 +0000202// Cursor visitor.
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000203class CursorVisitor : public DeclVisitor<CursorVisitor, bool>,
Douglas Gregora59e3902010-01-21 23:27:09 +0000204 public TypeLocVisitor<CursorVisitor, bool>,
205 public StmtVisitor<CursorVisitor, bool>
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000206{
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000207 /// \brief The translation unit we are traversing.
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000208 ASTUnit *TU;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000209
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000210 /// \brief The parent cursor whose children we are traversing.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000211 CXCursor Parent;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000212
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000213 /// \brief The declaration that serves at the parent of any statement or
214 /// expression nodes.
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000215 Decl *StmtParent;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000216
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000217 /// \brief The visitor function.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000218 CXCursorVisitor Visitor;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000219
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000220 /// \brief The opaque client data, to be passed along to the visitor.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000221 CXClientData ClientData;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000222
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000223 // MaxPCHLevel - the maximum PCH level of declarations that we will pass on
224 // to the visitor. Declarations with a PCH level greater than this value will
225 // be suppressed.
226 unsigned MaxPCHLevel;
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000227
228 /// \brief When valid, a source range to which the cursor should restrict
229 /// its search.
230 SourceRange RegionOfInterest;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000231
Douglas Gregorb1373d02010-01-20 20:59:29 +0000232 using DeclVisitor<CursorVisitor, bool>::Visit;
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000233 using TypeLocVisitor<CursorVisitor, bool>::Visit;
Douglas Gregora59e3902010-01-21 23:27:09 +0000234 using StmtVisitor<CursorVisitor, bool>::Visit;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000235
236 /// \brief Determine whether this particular source range comes before, comes
237 /// after, or overlaps the region of interest.
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000238 ///
Daniel Dunbard52864b2010-02-14 10:02:57 +0000239 /// \param R a half-open source range retrieved from the abstract syntax tree.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000240 RangeComparisonResult CompareRegionOfInterest(SourceRange R);
241
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000242 class SetParentRAII {
243 CXCursor &Parent;
244 Decl *&StmtParent;
245 CXCursor OldParent;
246
247 public:
248 SetParentRAII(CXCursor &Parent, Decl *&StmtParent, CXCursor NewParent)
249 : Parent(Parent), StmtParent(StmtParent), OldParent(Parent)
250 {
251 Parent = NewParent;
252 if (clang_isDeclaration(Parent.kind))
253 StmtParent = getCursorDecl(Parent);
254 }
255
256 ~SetParentRAII() {
257 Parent = OldParent;
258 if (clang_isDeclaration(Parent.kind))
259 StmtParent = getCursorDecl(Parent);
260 }
261 };
262
Steve Naroff89922f82009-08-31 00:59:03 +0000263public:
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000264 CursorVisitor(ASTUnit *TU, CXCursorVisitor Visitor, CXClientData ClientData,
265 unsigned MaxPCHLevel,
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000266 SourceRange RegionOfInterest = SourceRange())
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000267 : TU(TU), Visitor(Visitor), ClientData(ClientData),
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000268 MaxPCHLevel(MaxPCHLevel), RegionOfInterest(RegionOfInterest)
Douglas Gregorb1373d02010-01-20 20:59:29 +0000269 {
270 Parent.kind = CXCursor_NoDeclFound;
271 Parent.data[0] = 0;
272 Parent.data[1] = 0;
273 Parent.data[2] = 0;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000274 StmtParent = 0;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000275 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000276
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000277 bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false);
Douglas Gregor788f5a12010-03-20 00:41:21 +0000278
279 std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
280 getPreprocessedEntities();
281
Douglas Gregorb1373d02010-01-20 20:59:29 +0000282 bool VisitChildren(CXCursor Parent);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000283
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000284 // Declaration visitors
Ted Kremenek09dfa372010-02-18 05:46:33 +0000285 bool VisitAttributes(Decl *D);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000286 bool VisitBlockDecl(BlockDecl *B);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000287 bool VisitDeclContext(DeclContext *DC);
Ted Kremenek4540c9c2010-02-18 18:47:08 +0000288 bool VisitTranslationUnitDecl(TranslationUnitDecl *D);
289 bool VisitTypedefDecl(TypedefDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000290 bool VisitTagDecl(TagDecl *D);
291 bool VisitEnumConstantDecl(EnumConstantDecl *D);
292 bool VisitDeclaratorDecl(DeclaratorDecl *DD);
293 bool VisitFunctionDecl(FunctionDecl *ND);
294 bool VisitFieldDecl(FieldDecl *D);
Ted Kremenek4540c9c2010-02-18 18:47:08 +0000295 bool VisitVarDecl(VarDecl *);
Ted Kremenek79758f62010-02-18 22:36:18 +0000296 bool VisitObjCMethodDecl(ObjCMethodDecl *ND);
297 bool VisitObjCContainerDecl(ObjCContainerDecl *D);
298 bool VisitObjCCategoryDecl(ObjCCategoryDecl *ND);
299 bool VisitObjCProtocolDecl(ObjCProtocolDecl *PID);
Ted Kremenek23173d72010-05-18 21:09:07 +0000300 bool VisitObjCPropertyDecl(ObjCPropertyDecl *PD);
Ted Kremenek79758f62010-02-18 22:36:18 +0000301 bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
302 bool VisitObjCImplDecl(ObjCImplDecl *D);
303 bool VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
304 bool VisitObjCImplementationDecl(ObjCImplementationDecl *D);
305 // FIXME: ObjCPropertyDecl requires TypeSourceInfo, getter/setter locations,
306 // etc.
307 // FIXME: ObjCCompatibleAliasDecl requires aliased-class locations.
308 bool VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D);
309 bool VisitObjCClassDecl(ObjCClassDecl *D);
Ted Kremeneka0536d82010-05-07 01:04:29 +0000310 bool VisitLinkageSpecDecl(LinkageSpecDecl *D);
Ted Kremenek8f06e0e2010-05-06 23:38:21 +0000311 bool VisitNamespaceDecl(NamespaceDecl *D);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000312
313 // Type visitors
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000314 // FIXME: QualifiedTypeLoc doesn't provide any location information
315 bool VisitBuiltinTypeLoc(BuiltinTypeLoc TL);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000316 bool VisitTypedefTypeLoc(TypedefTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000317 bool VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL);
318 bool VisitTagTypeLoc(TagTypeLoc TL);
319 // FIXME: TemplateTypeParmTypeLoc doesn't provide any location information
320 bool VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL);
John McCallc12c5bb2010-05-15 11:32:37 +0000321 bool VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000322 bool VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL);
323 bool VisitPointerTypeLoc(PointerTypeLoc TL);
324 bool VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL);
325 bool VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL);
326 bool VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL);
327 bool VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL);
328 bool VisitFunctionTypeLoc(FunctionTypeLoc TL);
329 bool VisitArrayTypeLoc(ArrayTypeLoc TL);
Douglas Gregor2332c112010-01-21 20:48:56 +0000330 // FIXME: Implement for TemplateSpecializationTypeLoc
331 // FIXME: Implement visitors here when the unimplemented TypeLocs get
332 // implemented
333 bool VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL);
334 bool VisitTypeOfTypeLoc(TypeOfTypeLoc TL);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000335
Douglas Gregora59e3902010-01-21 23:27:09 +0000336 // Statement visitors
337 bool VisitStmt(Stmt *S);
338 bool VisitDeclStmt(DeclStmt *S);
Douglas Gregorf5bab412010-01-22 01:00:11 +0000339 // FIXME: LabelStmt label?
340 bool VisitIfStmt(IfStmt *S);
341 bool VisitSwitchStmt(SwitchStmt *S);
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000342 bool VisitCaseStmt(CaseStmt *S);
Douglas Gregor263b47b2010-01-25 16:12:32 +0000343 bool VisitWhileStmt(WhileStmt *S);
344 bool VisitForStmt(ForStmt *S);
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000345// bool VisitSwitchCase(SwitchCase *S);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000346
Douglas Gregor336fd812010-01-23 00:40:08 +0000347 // Expression visitors
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000348 bool VisitBlockExpr(BlockExpr *B);
Douglas Gregor336fd812010-01-23 00:40:08 +0000349 bool VisitCompoundLiteralExpr(CompoundLiteralExpr *E);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000350 bool VisitExplicitCastExpr(ExplicitCastExpr *E);
Douglas Gregorc2350e52010-03-08 16:40:19 +0000351 bool VisitObjCMessageExpr(ObjCMessageExpr *E);
Douglas Gregor81d34662010-04-20 15:39:42 +0000352 bool VisitObjCEncodeExpr(ObjCEncodeExpr *E);
Douglas Gregor8ecdb652010-04-28 22:16:22 +0000353 bool VisitOffsetOfExpr(OffsetOfExpr *E);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000354 bool VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E);
Steve Naroff89922f82009-08-31 00:59:03 +0000355};
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000356
Ted Kremenekab188932010-01-05 19:32:54 +0000357} // end anonymous namespace
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000358
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000359RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000360 return RangeCompare(TU->getSourceManager(), R, RegionOfInterest);
361}
362
Douglas Gregorb1373d02010-01-20 20:59:29 +0000363/// \brief Visit the given cursor and, if requested by the visitor,
364/// its children.
365///
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000366/// \param Cursor the cursor to visit.
367///
368/// \param CheckRegionOfInterest if true, then the caller already checked that
369/// this cursor is within the region of interest.
370///
Douglas Gregorb1373d02010-01-20 20:59:29 +0000371/// \returns true if the visitation should be aborted, false if it
372/// should continue.
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000373bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
Douglas Gregorb1373d02010-01-20 20:59:29 +0000374 if (clang_isInvalid(Cursor.kind))
375 return false;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000376
Douglas Gregorb1373d02010-01-20 20:59:29 +0000377 if (clang_isDeclaration(Cursor.kind)) {
378 Decl *D = getCursorDecl(Cursor);
379 assert(D && "Invalid declaration cursor");
380 if (D->getPCHLevel() > MaxPCHLevel)
381 return false;
382
383 if (D->isImplicit())
384 return false;
385 }
386
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000387 // If we have a range of interest, and this cursor doesn't intersect with it,
388 // we're done.
389 if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
Daniel Dunbarf408f322010-02-14 08:32:05 +0000390 SourceRange Range =
391 cxloc::translateCXSourceRange(clang_getCursorExtent(Cursor));
392 if (Range.isInvalid() || CompareRegionOfInterest(Range))
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000393 return false;
394 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000395
Douglas Gregorb1373d02010-01-20 20:59:29 +0000396 switch (Visitor(Cursor, Parent, ClientData)) {
397 case CXChildVisit_Break:
398 return true;
399
400 case CXChildVisit_Continue:
401 return false;
402
403 case CXChildVisit_Recurse:
404 return VisitChildren(Cursor);
405 }
406
Douglas Gregorfd643772010-01-25 16:45:46 +0000407 return false;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000408}
409
Douglas Gregor788f5a12010-03-20 00:41:21 +0000410std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
411CursorVisitor::getPreprocessedEntities() {
412 PreprocessingRecord &PPRec
413 = *TU->getPreprocessor().getPreprocessingRecord();
414
415 bool OnlyLocalDecls
416 = !TU->isMainFileAST() && TU->getOnlyLocalDecls();
417
418 // There is no region of interest; we have to walk everything.
419 if (RegionOfInterest.isInvalid())
420 return std::make_pair(PPRec.begin(OnlyLocalDecls),
421 PPRec.end(OnlyLocalDecls));
422
423 // Find the file in which the region of interest lands.
424 SourceManager &SM = TU->getSourceManager();
425 std::pair<FileID, unsigned> Begin
426 = SM.getDecomposedInstantiationLoc(RegionOfInterest.getBegin());
427 std::pair<FileID, unsigned> End
428 = SM.getDecomposedInstantiationLoc(RegionOfInterest.getEnd());
429
430 // The region of interest spans files; we have to walk everything.
431 if (Begin.first != End.first)
432 return std::make_pair(PPRec.begin(OnlyLocalDecls),
433 PPRec.end(OnlyLocalDecls));
434
435 ASTUnit::PreprocessedEntitiesByFileMap &ByFileMap
436 = TU->getPreprocessedEntitiesByFile();
437 if (ByFileMap.empty()) {
438 // Build the mapping from files to sets of preprocessed entities.
439 for (PreprocessingRecord::iterator E = PPRec.begin(OnlyLocalDecls),
440 EEnd = PPRec.end(OnlyLocalDecls);
441 E != EEnd; ++E) {
442 std::pair<FileID, unsigned> P
443 = SM.getDecomposedInstantiationLoc((*E)->getSourceRange().getBegin());
444 ByFileMap[P.first].push_back(*E);
445 }
446 }
447
448 return std::make_pair(ByFileMap[Begin.first].begin(),
449 ByFileMap[Begin.first].end());
450}
451
Douglas Gregorb1373d02010-01-20 20:59:29 +0000452/// \brief Visit the children of the given cursor.
453///
454/// \returns true if the visitation should be aborted, false if it
455/// should continue.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000456bool CursorVisitor::VisitChildren(CXCursor Cursor) {
Douglas Gregora59e3902010-01-21 23:27:09 +0000457 if (clang_isReference(Cursor.kind)) {
458 // By definition, references have no children.
459 return false;
460 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000461
462 // Set the Parent field to Cursor, then back to its old value once we're
Douglas Gregorb1373d02010-01-20 20:59:29 +0000463 // done.
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000464 SetParentRAII SetParent(Parent, StmtParent, Cursor);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000465
Douglas Gregorb1373d02010-01-20 20:59:29 +0000466 if (clang_isDeclaration(Cursor.kind)) {
467 Decl *D = getCursorDecl(Cursor);
468 assert(D && "Invalid declaration cursor");
Ted Kremenek539311e2010-02-18 18:47:01 +0000469 return VisitAttributes(D) || Visit(D);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000470 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000471
Douglas Gregora59e3902010-01-21 23:27:09 +0000472 if (clang_isStatement(Cursor.kind))
473 return Visit(getCursorStmt(Cursor));
474 if (clang_isExpression(Cursor.kind))
475 return Visit(getCursorExpr(Cursor));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000476
Douglas Gregorb1373d02010-01-20 20:59:29 +0000477 if (clang_isTranslationUnit(Cursor.kind)) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000478 ASTUnit *CXXUnit = getCursorASTUnit(Cursor);
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000479 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() &&
480 RegionOfInterest.isInvalid()) {
Douglas Gregor7b691f332010-01-20 21:13:59 +0000481 const std::vector<Decl*> &TLDs = CXXUnit->getTopLevelDecls();
482 for (std::vector<Decl*>::const_iterator it = TLDs.begin(),
483 ie = TLDs.end(); it != ie; ++it) {
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000484 if (Visit(MakeCXCursor(*it, CXXUnit), true))
Douglas Gregor7b691f332010-01-20 21:13:59 +0000485 return true;
486 }
Douglas Gregor0396f462010-03-19 05:22:59 +0000487 } else if (VisitDeclContext(
488 CXXUnit->getASTContext().getTranslationUnitDecl()))
489 return true;
Bob Wilson3178cb62010-03-19 03:57:57 +0000490
Douglas Gregor0396f462010-03-19 05:22:59 +0000491 // Walk the preprocessing record.
Daniel Dunbar8de30ff2010-03-20 01:11:56 +0000492 if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
Douglas Gregor0396f462010-03-19 05:22:59 +0000493 // FIXME: Once we have the ability to deserialize a preprocessing record,
494 // do so.
Douglas Gregor788f5a12010-03-20 00:41:21 +0000495 PreprocessingRecord::iterator E, EEnd;
496 for (llvm::tie(E, EEnd) = getPreprocessedEntities(); E != EEnd; ++E) {
Douglas Gregor0396f462010-03-19 05:22:59 +0000497 if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) {
498 if (Visit(MakeMacroInstantiationCursor(MI, CXXUnit)))
499 return true;
Douglas Gregor788f5a12010-03-20 00:41:21 +0000500
Douglas Gregor0396f462010-03-19 05:22:59 +0000501 continue;
502 }
503
504 if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
505 if (Visit(MakeMacroDefinitionCursor(MD, CXXUnit)))
506 return true;
507
508 continue;
509 }
510 }
511 }
Douglas Gregor7b691f332010-01-20 21:13:59 +0000512 return false;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000513 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000514
Douglas Gregorb1373d02010-01-20 20:59:29 +0000515 // Nothing to visit at the moment.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000516 return false;
517}
518
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000519bool CursorVisitor::VisitBlockDecl(BlockDecl *B) {
John McCallfc929202010-06-04 22:33:30 +0000520 if (Visit(B->getSignatureAsWritten()->getTypeLoc()))
521 return true;
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000522
523 return Visit(MakeCXCursor(B->getBody(), StmtParent, TU));
524}
525
Douglas Gregorb1373d02010-01-20 20:59:29 +0000526bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000527 for (DeclContext::decl_iterator
Douglas Gregorb1373d02010-01-20 20:59:29 +0000528 I = DC->decls_begin(), E = DC->decls_end(); I != E; ++I) {
Ted Kremenek09dfa372010-02-18 05:46:33 +0000529
Ted Kremenek23173d72010-05-18 21:09:07 +0000530 Decl *D = *I;
531 if (D->getLexicalDeclContext() != DC)
532 continue;
533
534 CXCursor Cursor = MakeCXCursor(D, TU);
Daniel Dunbard52864b2010-02-14 10:02:57 +0000535
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000536 if (RegionOfInterest.isValid()) {
Daniel Dunbard52864b2010-02-14 10:02:57 +0000537 SourceRange Range =
538 cxloc::translateCXSourceRange(clang_getCursorExtent(Cursor));
539 if (Range.isInvalid())
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000540 continue;
Daniel Dunbard52864b2010-02-14 10:02:57 +0000541
542 switch (CompareRegionOfInterest(Range)) {
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000543 case RangeBefore:
544 // This declaration comes before the region of interest; skip it.
545 continue;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000546
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000547 case RangeAfter:
548 // This declaration comes after the region of interest; we're done.
549 return false;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000550
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000551 case RangeOverlap:
552 // This declaration overlaps the region of interest; visit it.
553 break;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000554 }
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000555 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000556
Daniel Dunbard52864b2010-02-14 10:02:57 +0000557 if (Visit(Cursor, true))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000558 return true;
559 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000560
Douglas Gregorb1373d02010-01-20 20:59:29 +0000561 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000562}
563
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000564bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
565 llvm_unreachable("Translation units are visited directly by Visit()");
566 return false;
567}
568
569bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
570 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
571 return Visit(TSInfo->getTypeLoc());
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000572
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000573 return false;
574}
575
576bool CursorVisitor::VisitTagDecl(TagDecl *D) {
577 return VisitDeclContext(D);
578}
579
580bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
581 if (Expr *Init = D->getInitExpr())
582 return Visit(MakeCXCursor(Init, StmtParent, TU));
583 return false;
584}
585
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000586bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
587 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
588 if (Visit(TSInfo->getTypeLoc()))
589 return true;
590
591 return false;
592}
593
Douglas Gregorb1373d02010-01-20 20:59:29 +0000594bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000595 if (VisitDeclaratorDecl(ND))
596 return true;
597
Douglas Gregora59e3902010-01-21 23:27:09 +0000598 if (ND->isThisDeclarationADefinition() &&
599 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
600 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000601
Douglas Gregorb1373d02010-01-20 20:59:29 +0000602 return false;
603}
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000604
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000605bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
606 if (VisitDeclaratorDecl(D))
607 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000608
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000609 if (Expr *BitWidth = D->getBitWidth())
610 return Visit(MakeCXCursor(BitWidth, StmtParent, TU));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000611
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000612 return false;
613}
614
615bool CursorVisitor::VisitVarDecl(VarDecl *D) {
616 if (VisitDeclaratorDecl(D))
617 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000618
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000619 if (Expr *Init = D->getInit())
620 return Visit(MakeCXCursor(Init, StmtParent, TU));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000621
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000622 return false;
623}
624
625bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
Douglas Gregor4bc1cb62010-03-08 14:59:44 +0000626 if (TypeSourceInfo *TSInfo = ND->getResultTypeSourceInfo())
627 if (Visit(TSInfo->getTypeLoc()))
628 return true;
629
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000630 for (ObjCMethodDecl::param_iterator P = ND->param_begin(),
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000631 PEnd = ND->param_end();
632 P != PEnd; ++P) {
633 if (Visit(MakeCXCursor(*P, TU)))
634 return true;
635 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000636
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000637 if (ND->isThisDeclarationADefinition() &&
638 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
639 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000640
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000641 return false;
642}
643
Douglas Gregora59e3902010-01-21 23:27:09 +0000644bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
645 return VisitDeclContext(D);
646}
647
Douglas Gregorb1373d02010-01-20 20:59:29 +0000648bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000649 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
650 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000651 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000652
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000653 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
654 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
655 E = ND->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000656 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000657 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000658
Douglas Gregora59e3902010-01-21 23:27:09 +0000659 return VisitObjCContainerDecl(ND);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000660}
661
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000662bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
663 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
664 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
665 E = PID->protocol_end(); I != E; ++I, ++PL)
666 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
667 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000668
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000669 return VisitObjCContainerDecl(PID);
670}
671
Ted Kremenek23173d72010-05-18 21:09:07 +0000672bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
John McCallfc929202010-06-04 22:33:30 +0000673 if (Visit(PD->getTypeSourceInfo()->getTypeLoc()))
674 return true;
675
Ted Kremenek23173d72010-05-18 21:09:07 +0000676 // FIXME: This implements a workaround with @property declarations also being
677 // installed in the DeclContext for the @interface. Eventually this code
678 // should be removed.
679 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
680 if (!CDecl || !CDecl->IsClassExtension())
681 return false;
682
683 ObjCInterfaceDecl *ID = CDecl->getClassInterface();
684 if (!ID)
685 return false;
686
687 IdentifierInfo *PropertyId = PD->getIdentifier();
688 ObjCPropertyDecl *prevDecl =
689 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId);
690
691 if (!prevDecl)
692 return false;
693
694 // Visit synthesized methods since they will be skipped when visiting
695 // the @interface.
696 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
697 if (MD->isSynthesized())
698 if (Visit(MakeCXCursor(MD, TU)))
699 return true;
700
701 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
702 if (MD->isSynthesized())
703 if (Visit(MakeCXCursor(MD, TU)))
704 return true;
705
706 return false;
707}
708
Douglas Gregorb1373d02010-01-20 20:59:29 +0000709bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000710 // Issue callbacks for super class.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000711 if (D->getSuperClass() &&
712 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000713 D->getSuperClassLoc(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000714 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000715 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000716
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000717 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
718 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
719 E = D->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000720 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000721 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000722
Douglas Gregora59e3902010-01-21 23:27:09 +0000723 return VisitObjCContainerDecl(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000724}
725
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000726bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
727 return VisitObjCContainerDecl(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000728}
729
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000730bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
Ted Kremenekebfa3392010-03-19 20:39:03 +0000731 // 'ID' could be null when dealing with invalid code.
732 if (ObjCInterfaceDecl *ID = D->getClassInterface())
733 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
734 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000735
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000736 return VisitObjCImplDecl(D);
737}
738
739bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
740#if 0
741 // Issue callbacks for super class.
742 // FIXME: No source location information!
743 if (D->getSuperClass() &&
744 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000745 D->getSuperClassLoc(),
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000746 TU)))
747 return true;
748#endif
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000749
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000750 return VisitObjCImplDecl(D);
751}
752
753bool CursorVisitor::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
754 ObjCForwardProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
755 for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(),
756 E = D->protocol_end();
757 I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000758 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000759 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000760
761 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000762}
763
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000764bool CursorVisitor::VisitObjCClassDecl(ObjCClassDecl *D) {
765 for (ObjCClassDecl::iterator C = D->begin(), CEnd = D->end(); C != CEnd; ++C)
766 if (Visit(MakeCursorObjCClassRef(C->getInterface(), C->getLocation(), TU)))
767 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000768
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000769 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000770}
771
Ted Kremenek8f06e0e2010-05-06 23:38:21 +0000772bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
773 return VisitDeclContext(D);
774}
775
Ted Kremeneka0536d82010-05-07 01:04:29 +0000776bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
777 return VisitDeclContext(D);
778}
779
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000780bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
781 ASTContext &Context = TU->getASTContext();
782
783 // Some builtin types (such as Objective-C's "id", "sel", and
784 // "Class") have associated declarations. Create cursors for those.
785 QualType VisitType;
786 switch (TL.getType()->getAs<BuiltinType>()->getKind()) {
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000787 case BuiltinType::Void:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000788 case BuiltinType::Bool:
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000789 case BuiltinType::Char_U:
790 case BuiltinType::UChar:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000791 case BuiltinType::Char16:
792 case BuiltinType::Char32:
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000793 case BuiltinType::UShort:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000794 case BuiltinType::UInt:
795 case BuiltinType::ULong:
796 case BuiltinType::ULongLong:
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000797 case BuiltinType::UInt128:
798 case BuiltinType::Char_S:
799 case BuiltinType::SChar:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000800 case BuiltinType::WChar:
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000801 case BuiltinType::Short:
802 case BuiltinType::Int:
803 case BuiltinType::Long:
804 case BuiltinType::LongLong:
805 case BuiltinType::Int128:
806 case BuiltinType::Float:
807 case BuiltinType::Double:
808 case BuiltinType::LongDouble:
809 case BuiltinType::NullPtr:
810 case BuiltinType::Overload:
811 case BuiltinType::Dependent:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000812 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000813
814 case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor?
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000815 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000816
Ted Kremenekc4174cc2010-02-18 18:52:18 +0000817 case BuiltinType::ObjCId:
818 VisitType = Context.getObjCIdType();
819 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000820
821 case BuiltinType::ObjCClass:
822 VisitType = Context.getObjCClassType();
823 break;
824
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000825 case BuiltinType::ObjCSel:
826 VisitType = Context.getObjCSelType();
827 break;
828 }
829
830 if (!VisitType.isNull()) {
831 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000832 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000833 TU));
834 }
835
836 return false;
837}
838
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000839bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
840 return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU));
841}
842
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000843bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
844 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
845}
846
847bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
848 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
849}
850
851bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
852 if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU)))
853 return true;
854
John McCallc12c5bb2010-05-15 11:32:37 +0000855 return false;
856}
857
858bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
859 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
860 return true;
861
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000862 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
863 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
864 TU)))
865 return true;
866 }
867
868 return false;
869}
870
871bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
John McCallc12c5bb2010-05-15 11:32:37 +0000872 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000873}
874
875bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
876 return Visit(TL.getPointeeLoc());
877}
878
879bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
880 return Visit(TL.getPointeeLoc());
881}
882
883bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
884 return Visit(TL.getPointeeLoc());
885}
886
887bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000888 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000889}
890
891bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000892 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000893}
894
895bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
896 if (Visit(TL.getResultLoc()))
897 return true;
898
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000899 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
Ted Kremenek5dbacb42010-04-07 00:27:13 +0000900 if (Decl *D = TL.getArg(I))
901 if (Visit(MakeCXCursor(D, TU)))
902 return true;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000903
904 return false;
905}
906
907bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
908 if (Visit(TL.getElementLoc()))
909 return true;
910
911 if (Expr *Size = TL.getSizeExpr())
912 return Visit(MakeCXCursor(Size, StmtParent, TU));
913
914 return false;
915}
916
Douglas Gregor2332c112010-01-21 20:48:56 +0000917bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
918 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
919}
920
921bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
922 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
923 return Visit(TSInfo->getTypeLoc());
924
925 return false;
926}
927
Douglas Gregora59e3902010-01-21 23:27:09 +0000928bool CursorVisitor::VisitStmt(Stmt *S) {
929 for (Stmt::child_iterator Child = S->child_begin(), ChildEnd = S->child_end();
930 Child != ChildEnd; ++Child) {
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000931 if (Stmt *C = *Child)
932 if (Visit(MakeCXCursor(C, StmtParent, TU)))
933 return true;
Douglas Gregora59e3902010-01-21 23:27:09 +0000934 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000935
Douglas Gregora59e3902010-01-21 23:27:09 +0000936 return false;
937}
938
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000939bool CursorVisitor::VisitCaseStmt(CaseStmt *S) {
940 // Specially handle CaseStmts because they can be nested, e.g.:
941 //
942 // case 1:
943 // case 2:
944 //
945 // In this case the second CaseStmt is the child of the first. Walking
946 // these recursively can blow out the stack.
947 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU);
948 while (true) {
949 // Set the Parent field to Cursor, then back to its old value once we're
950 // done.
951 SetParentRAII SetParent(Parent, StmtParent, Cursor);
952
953 if (Stmt *LHS = S->getLHS())
954 if (Visit(MakeCXCursor(LHS, StmtParent, TU)))
955 return true;
956 if (Stmt *RHS = S->getRHS())
957 if (Visit(MakeCXCursor(RHS, StmtParent, TU)))
958 return true;
959 if (Stmt *SubStmt = S->getSubStmt()) {
960 if (!isa<CaseStmt>(SubStmt))
961 return Visit(MakeCXCursor(SubStmt, StmtParent, TU));
962
963 // Specially handle 'CaseStmt' so that we don't blow out the stack.
964 CaseStmt *CS = cast<CaseStmt>(SubStmt);
965 Cursor = MakeCXCursor(CS, StmtParent, TU);
966 if (RegionOfInterest.isValid()) {
967 SourceRange Range = CS->getSourceRange();
968 if (Range.isInvalid() || CompareRegionOfInterest(Range))
969 return false;
970 }
971
972 switch (Visitor(Cursor, Parent, ClientData)) {
973 case CXChildVisit_Break: return true;
974 case CXChildVisit_Continue: return false;
975 case CXChildVisit_Recurse:
976 // Perform tail-recursion manually.
977 S = CS;
978 continue;
979 }
980 }
981 return false;
982 }
983}
984
Douglas Gregora59e3902010-01-21 23:27:09 +0000985bool CursorVisitor::VisitDeclStmt(DeclStmt *S) {
986 for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end();
987 D != DEnd; ++D) {
Douglas Gregor263b47b2010-01-25 16:12:32 +0000988 if (*D && Visit(MakeCXCursor(*D, TU)))
Douglas Gregora59e3902010-01-21 23:27:09 +0000989 return true;
990 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000991
Douglas Gregora59e3902010-01-21 23:27:09 +0000992 return false;
993}
994
Douglas Gregorf5bab412010-01-22 01:00:11 +0000995bool CursorVisitor::VisitIfStmt(IfStmt *S) {
996 if (VarDecl *Var = S->getConditionVariable()) {
997 if (Visit(MakeCXCursor(Var, TU)))
998 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000999 }
1000
Douglas Gregor263b47b2010-01-25 16:12:32 +00001001 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1002 return true;
Douglas Gregorf5bab412010-01-22 01:00:11 +00001003 if (S->getThen() && Visit(MakeCXCursor(S->getThen(), StmtParent, TU)))
1004 return true;
Douglas Gregorf5bab412010-01-22 01:00:11 +00001005 if (S->getElse() && Visit(MakeCXCursor(S->getElse(), StmtParent, TU)))
1006 return true;
1007
1008 return false;
1009}
1010
1011bool CursorVisitor::VisitSwitchStmt(SwitchStmt *S) {
1012 if (VarDecl *Var = S->getConditionVariable()) {
1013 if (Visit(MakeCXCursor(Var, TU)))
1014 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001015 }
1016
Douglas Gregor263b47b2010-01-25 16:12:32 +00001017 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1018 return true;
1019 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1020 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001021
Douglas Gregor263b47b2010-01-25 16:12:32 +00001022 return false;
1023}
1024
1025bool CursorVisitor::VisitWhileStmt(WhileStmt *S) {
1026 if (VarDecl *Var = S->getConditionVariable()) {
1027 if (Visit(MakeCXCursor(Var, TU)))
1028 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001029 }
1030
Douglas Gregor263b47b2010-01-25 16:12:32 +00001031 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1032 return true;
1033 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
Douglas Gregorf5bab412010-01-22 01:00:11 +00001034 return true;
1035
Douglas Gregor263b47b2010-01-25 16:12:32 +00001036 return false;
1037}
1038
1039bool CursorVisitor::VisitForStmt(ForStmt *S) {
1040 if (S->getInit() && Visit(MakeCXCursor(S->getInit(), StmtParent, TU)))
1041 return true;
1042 if (VarDecl *Var = S->getConditionVariable()) {
1043 if (Visit(MakeCXCursor(Var, TU)))
1044 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001045 }
1046
Douglas Gregor263b47b2010-01-25 16:12:32 +00001047 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1048 return true;
1049 if (S->getInc() && Visit(MakeCXCursor(S->getInc(), StmtParent, TU)))
1050 return true;
Douglas Gregorf5bab412010-01-22 01:00:11 +00001051 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1052 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001053
Douglas Gregorf5bab412010-01-22 01:00:11 +00001054 return false;
1055}
1056
Ted Kremenek1ee6cad2010-04-11 21:47:37 +00001057bool CursorVisitor::VisitBlockExpr(BlockExpr *B) {
1058 return Visit(B->getBlockDecl());
1059}
1060
Douglas Gregor8ecdb652010-04-28 22:16:22 +00001061bool CursorVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) {
1062 // FIXME: Visit fields as well?
1063 if (Visit(E->getTypeSourceInfo()->getTypeLoc()))
1064 return true;
1065
1066 return VisitExpr(E);
1067}
1068
Douglas Gregor336fd812010-01-23 00:40:08 +00001069bool CursorVisitor::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E) {
1070 if (E->isArgumentType()) {
1071 if (TypeSourceInfo *TSInfo = E->getArgumentTypeInfo())
1072 return Visit(TSInfo->getTypeLoc());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001073
Douglas Gregor336fd812010-01-23 00:40:08 +00001074 return false;
1075 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001076
Douglas Gregor336fd812010-01-23 00:40:08 +00001077 return VisitExpr(E);
1078}
1079
1080bool CursorVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) {
1081 if (TypeSourceInfo *TSInfo = E->getTypeInfoAsWritten())
1082 if (Visit(TSInfo->getTypeLoc()))
1083 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001084
Douglas Gregor336fd812010-01-23 00:40:08 +00001085 return VisitCastExpr(E);
1086}
1087
1088bool CursorVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) {
1089 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1090 if (Visit(TSInfo->getTypeLoc()))
1091 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001092
Douglas Gregor336fd812010-01-23 00:40:08 +00001093 return VisitExpr(E);
1094}
1095
Douglas Gregorc2350e52010-03-08 16:40:19 +00001096bool CursorVisitor::VisitObjCMessageExpr(ObjCMessageExpr *E) {
Douglas Gregor04badcf2010-04-21 00:45:42 +00001097 if (TypeSourceInfo *TSInfo = E->getClassReceiverTypeInfo())
1098 if (Visit(TSInfo->getTypeLoc()))
1099 return true;
Douglas Gregorc2350e52010-03-08 16:40:19 +00001100
1101 return VisitExpr(E);
1102}
1103
Douglas Gregor81d34662010-04-20 15:39:42 +00001104bool CursorVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) {
1105 return Visit(E->getEncodedTypeSourceInfo()->getTypeLoc());
1106}
1107
1108
Ted Kremenek09dfa372010-02-18 05:46:33 +00001109bool CursorVisitor::VisitAttributes(Decl *D) {
1110 for (const Attr *A = D->getAttrs(); A; A = A->getNext())
1111 if (Visit(MakeCXCursor(A, D, TU)))
1112 return true;
1113
1114 return false;
1115}
1116
Benjamin Kramer5e4bc592009-10-18 16:11:04 +00001117extern "C" {
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001118CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
1119 int displayDiagnostics) {
Douglas Gregora030b7c2010-01-22 20:35:53 +00001120 CIndexer *CIdxr = new CIndexer();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00001121 if (excludeDeclarationsFromPCH)
1122 CIdxr->setOnlyLocalDecls();
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001123 if (displayDiagnostics)
1124 CIdxr->setDisplayDiagnostics();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00001125 return CIdxr;
Steve Naroff600866c2009-08-27 19:51:58 +00001126}
1127
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001128void clang_disposeIndex(CXIndex CIdx) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001129 if (CIdx)
1130 delete static_cast<CIndexer *>(CIdx);
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00001131}
1132
Daniel Dunbar8506dde2009-12-03 01:54:28 +00001133void clang_setUseExternalASTGeneration(CXIndex CIdx, int value) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001134 if (CIdx) {
1135 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
1136 CXXIdx->setUseExternalASTGeneration(value);
1137 }
Daniel Dunbar8506dde2009-12-03 01:54:28 +00001138}
1139
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001140CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
Douglas Gregora88084b2010-02-18 18:08:43 +00001141 const char *ast_filename) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001142 if (!CIdx)
1143 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001144
Douglas Gregor7d1d49d2009-10-16 20:01:17 +00001145 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001146
Douglas Gregor28019772010-04-05 23:52:57 +00001147 llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
1148 return ASTUnit::LoadFromPCHFile(ast_filename, Diags,
Douglas Gregora88084b2010-02-18 18:08:43 +00001149 CXXIdx->getOnlyLocalDecls(),
1150 0, 0, true);
Steve Naroff600866c2009-08-27 19:51:58 +00001151}
1152
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001153CXTranslationUnit
1154clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
1155 const char *source_filename,
1156 int num_command_line_args,
Douglas Gregor4db64a42010-01-23 00:14:00 +00001157 const char **command_line_args,
1158 unsigned num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +00001159 struct CXUnsavedFile *unsaved_files) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001160 if (!CIdx)
1161 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001162
Steve Naroffe56b4ba2009-10-20 14:46:24 +00001163 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
1164
Douglas Gregor5352ac02010-01-28 00:27:43 +00001165 // Configure the diagnostics.
1166 DiagnosticOptions DiagOpts;
Douglas Gregor28019772010-04-05 23:52:57 +00001167 llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
1168 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001169
Douglas Gregor4db64a42010-01-23 00:14:00 +00001170 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
1171 for (unsigned I = 0; I != num_unsaved_files; ++I) {
Chris Lattnera0a270c2010-04-05 22:42:27 +00001172 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001173 const llvm::MemoryBuffer *Buffer
Chris Lattnera0a270c2010-04-05 22:42:27 +00001174 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
Douglas Gregor4db64a42010-01-23 00:14:00 +00001175 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
1176 Buffer));
1177 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001178
Daniel Dunbar8506dde2009-12-03 01:54:28 +00001179 if (!CXXIdx->getUseExternalASTGeneration()) {
1180 llvm::SmallVector<const char *, 16> Args;
1181
1182 // The 'source_filename' argument is optional. If the caller does not
1183 // specify it then it is assumed that the source file is specified
1184 // in the actual argument list.
1185 if (source_filename)
1186 Args.push_back(source_filename);
1187 Args.insert(Args.end(), command_line_args,
1188 command_line_args + num_command_line_args);
Douglas Gregor94dc8f62010-03-19 16:15:56 +00001189 Args.push_back("-Xclang");
1190 Args.push_back("-detailed-preprocessing-record");
Douglas Gregor5352ac02010-01-28 00:27:43 +00001191 unsigned NumErrors = Diags->getNumErrors();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001192
Ted Kremenek29b72842010-01-07 22:49:05 +00001193#ifdef USE_CRASHTRACER
1194 ArgsCrashTracerInfo ACTI(Args);
Ted Kremenek8a8da7d2010-01-06 03:42:32 +00001195#endif
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001196
Daniel Dunbar94220972009-12-05 02:17:18 +00001197 llvm::OwningPtr<ASTUnit> Unit(
1198 ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(),
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001199 Diags,
Daniel Dunbar869824e2009-12-13 03:46:13 +00001200 CXXIdx->getClangResourcesPath(),
Daniel Dunbar94220972009-12-05 02:17:18 +00001201 CXXIdx->getOnlyLocalDecls(),
Douglas Gregor4db64a42010-01-23 00:14:00 +00001202 RemappedFiles.data(),
Douglas Gregora88084b2010-02-18 18:08:43 +00001203 RemappedFiles.size(),
Douglas Gregor94dc8f62010-03-19 16:15:56 +00001204 /*CaptureDiagnostics=*/true));
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001205
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001206 if (NumErrors != Diags->getNumErrors()) {
Ted Kremenek34f6a322010-03-05 22:43:29 +00001207 // Make sure to check that 'Unit' is non-NULL.
1208 if (CXXIdx->getDisplayDiagnostics() && Unit.get()) {
Douglas Gregor405634b2010-04-05 18:10:21 +00001209 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
1210 DEnd = Unit->stored_diag_end();
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001211 D != DEnd; ++D) {
1212 CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions());
Douglas Gregor274f1902010-02-22 23:17:23 +00001213 CXString Msg = clang_formatDiagnostic(&Diag,
1214 clang_defaultDiagnosticDisplayOptions());
1215 fprintf(stderr, "%s\n", clang_getCString(Msg));
1216 clang_disposeString(Msg);
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001217 }
Douglas Gregor274f1902010-02-22 23:17:23 +00001218#ifdef LLVM_ON_WIN32
1219 // On Windows, force a flush, since there may be multiple copies of
1220 // stderr and stdout in the file system, all with different buffers
1221 // but writing to the same device.
1222 fflush(stderr);
Ted Kremenek83c51842010-03-26 01:34:51 +00001223#endif
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001224 }
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001225 }
Daniel Dunbar94220972009-12-05 02:17:18 +00001226
1227 return Unit.take();
Daniel Dunbar8506dde2009-12-03 01:54:28 +00001228 }
1229
Ted Kremenek139ba862009-10-22 00:03:57 +00001230 // Build up the arguments for invoking 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +00001231 std::vector<const char *> argv;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001232
Ted Kremenek139ba862009-10-22 00:03:57 +00001233 // First add the complete path to the 'clang' executable.
1234 llvm::sys::Path ClangPath = static_cast<CIndexer *>(CIdx)->getClangPath();
Benjamin Kramer5e4bc592009-10-18 16:11:04 +00001235 argv.push_back(ClangPath.c_str());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001236
Ted Kremenek139ba862009-10-22 00:03:57 +00001237 // Add the '-emit-ast' option as our execution mode for 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +00001238 argv.push_back("-emit-ast");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001239
Ted Kremenek139ba862009-10-22 00:03:57 +00001240 // The 'source_filename' argument is optional. If the caller does not
1241 // specify it then it is assumed that the source file is specified
1242 // in the actual argument list.
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001243 if (source_filename)
1244 argv.push_back(source_filename);
Ted Kremenek139ba862009-10-22 00:03:57 +00001245
Steve Naroff37b5ac22009-10-15 20:50:09 +00001246 // Generate a temporary name for the AST file.
Ted Kremenek139ba862009-10-22 00:03:57 +00001247 argv.push_back("-o");
Benjamin Kramerc2a98162010-03-13 21:22:49 +00001248 char astTmpFile[L_tmpnam];
1249 argv.push_back(tmpnam(astTmpFile));
Ted Kremenek139ba862009-10-22 00:03:57 +00001250
Douglas Gregor4db64a42010-01-23 00:14:00 +00001251 // Remap any unsaved files to temporary files.
1252 std::vector<llvm::sys::Path> TemporaryFiles;
1253 std::vector<std::string> RemapArgs;
1254 if (RemapFiles(num_unsaved_files, unsaved_files, RemapArgs, TemporaryFiles))
1255 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001256
Douglas Gregor4db64a42010-01-23 00:14:00 +00001257 // The pointers into the elements of RemapArgs are stable because we
1258 // won't be adding anything to RemapArgs after this point.
1259 for (unsigned i = 0, e = RemapArgs.size(); i != e; ++i)
1260 argv.push_back(RemapArgs[i].c_str());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001261
Ted Kremenek139ba862009-10-22 00:03:57 +00001262 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
1263 for (int i = 0; i < num_command_line_args; ++i)
1264 if (const char *arg = command_line_args[i]) {
1265 if (strcmp(arg, "-o") == 0) {
1266 ++i; // Also skip the matching argument.
1267 continue;
1268 }
1269 if (strcmp(arg, "-emit-ast") == 0 ||
1270 strcmp(arg, "-c") == 0 ||
1271 strcmp(arg, "-fsyntax-only") == 0) {
1272 continue;
1273 }
1274
1275 // Keep the argument.
1276 argv.push_back(arg);
Steve Naroffe56b4ba2009-10-20 14:46:24 +00001277 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001278
Douglas Gregord93256e2010-01-28 06:00:51 +00001279 // Generate a temporary name for the diagnostics file.
Benjamin Kramerc2a98162010-03-13 21:22:49 +00001280 char tmpFileResults[L_tmpnam];
1281 char *tmpResultsFileName = tmpnam(tmpFileResults);
1282 llvm::sys::Path DiagnosticsFile(tmpResultsFileName);
Douglas Gregord93256e2010-01-28 06:00:51 +00001283 TemporaryFiles.push_back(DiagnosticsFile);
1284 argv.push_back("-fdiagnostics-binary");
1285
Douglas Gregor94dc8f62010-03-19 16:15:56 +00001286 argv.push_back("-Xclang");
1287 argv.push_back("-detailed-preprocessing-record");
1288
Ted Kremenek139ba862009-10-22 00:03:57 +00001289 // Add the null terminator.
Ted Kremenek74cd0692009-10-15 23:21:22 +00001290 argv.push_back(NULL);
1291
Ted Kremenekfeb15e32009-10-26 22:14:08 +00001292 // Invoke 'clang'.
1293 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
1294 // on Unix or NUL (Windows).
Ted Kremenek379afec2009-10-22 03:24:01 +00001295 std::string ErrMsg;
Douglas Gregord93256e2010-01-28 06:00:51 +00001296 const llvm::sys::Path *Redirects[] = { &DevNull, &DevNull, &DiagnosticsFile,
1297 NULL };
Ted Kremenek379afec2009-10-22 03:24:01 +00001298 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
Douglas Gregor936ea3b2010-01-28 00:56:43 +00001299 /* redirects */ &Redirects[0],
Ted Kremenek379afec2009-10-22 03:24:01 +00001300 /* secondsToWait */ 0, /* memoryLimits */ 0, &ErrMsg);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001301
Douglas Gregor936ea3b2010-01-28 00:56:43 +00001302 if (!ErrMsg.empty()) {
1303 std::string AllArgs;
Ted Kremenek379afec2009-10-22 03:24:01 +00001304 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
Douglas Gregor936ea3b2010-01-28 00:56:43 +00001305 I != E; ++I) {
1306 AllArgs += ' ';
Ted Kremenek779e5f42009-10-26 22:08:39 +00001307 if (*I)
Douglas Gregor936ea3b2010-01-28 00:56:43 +00001308 AllArgs += *I;
Ted Kremenek779e5f42009-10-26 22:08:39 +00001309 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001310
Daniel Dunbar32141c82010-02-23 20:23:45 +00001311 Diags->Report(diag::err_fe_invoking) << AllArgs << ErrMsg;
Ted Kremenek379afec2009-10-22 03:24:01 +00001312 }
Benjamin Kramer0829a832009-10-18 11:19:36 +00001313
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001314 ASTUnit *ATU = ASTUnit::LoadFromPCHFile(astTmpFile, Diags,
Douglas Gregor4db64a42010-01-23 00:14:00 +00001315 CXXIdx->getOnlyLocalDecls(),
Douglas Gregor4db64a42010-01-23 00:14:00 +00001316 RemappedFiles.data(),
Douglas Gregora88084b2010-02-18 18:08:43 +00001317 RemappedFiles.size(),
1318 /*CaptureDiagnostics=*/true);
Douglas Gregora88084b2010-02-18 18:08:43 +00001319 if (ATU) {
1320 LoadSerializedDiagnostics(DiagnosticsFile,
1321 num_unsaved_files, unsaved_files,
1322 ATU->getFileManager(),
1323 ATU->getSourceManager(),
Douglas Gregor405634b2010-04-05 18:10:21 +00001324 ATU->getStoredDiagnostics());
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001325 } else if (CXXIdx->getDisplayDiagnostics()) {
1326 // We failed to load the ASTUnit, but we can still deserialize the
1327 // diagnostics and emit them.
1328 FileManager FileMgr;
Douglas Gregorf715ca12010-03-16 00:06:06 +00001329 Diagnostic Diag;
1330 SourceManager SourceMgr(Diag);
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001331 // FIXME: Faked LangOpts!
1332 LangOptions LangOpts;
1333 llvm::SmallVector<StoredDiagnostic, 4> Diags;
1334 LoadSerializedDiagnostics(DiagnosticsFile,
1335 num_unsaved_files, unsaved_files,
1336 FileMgr, SourceMgr, Diags);
1337 for (llvm::SmallVector<StoredDiagnostic, 4>::iterator D = Diags.begin(),
1338 DEnd = Diags.end();
1339 D != DEnd; ++D) {
1340 CXStoredDiagnostic Diag(*D, LangOpts);
Douglas Gregor274f1902010-02-22 23:17:23 +00001341 CXString Msg = clang_formatDiagnostic(&Diag,
1342 clang_defaultDiagnosticDisplayOptions());
1343 fprintf(stderr, "%s\n", clang_getCString(Msg));
1344 clang_disposeString(Msg);
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001345 }
Douglas Gregor274f1902010-02-22 23:17:23 +00001346
1347#ifdef LLVM_ON_WIN32
1348 // On Windows, force a flush, since there may be multiple copies of
1349 // stderr and stdout in the file system, all with different buffers
1350 // but writing to the same device.
1351 fflush(stderr);
1352#endif
Douglas Gregora88084b2010-02-18 18:08:43 +00001353 }
Douglas Gregord93256e2010-01-28 06:00:51 +00001354
Douglas Gregor313e26c2010-02-18 23:35:40 +00001355 if (ATU) {
1356 // Make the translation unit responsible for destroying all temporary files.
1357 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i)
1358 ATU->addTemporaryFile(TemporaryFiles[i]);
1359 ATU->addTemporaryFile(llvm::sys::Path(ATU->getPCHFileName()));
1360 } else {
1361 // Destroy all of the temporary files now; they can't be referenced any
1362 // longer.
1363 llvm::sys::Path(astTmpFile).eraseFromDisk();
1364 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i)
1365 TemporaryFiles[i].eraseFromDisk();
1366 }
1367
Steve Naroffe19944c2009-10-15 22:23:48 +00001368 return ATU;
Steve Naroff5b7d8e22009-10-15 20:04:39 +00001369}
1370
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001371void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001372 if (CTUnit)
1373 delete static_cast<ASTUnit *>(CTUnit);
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00001374}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001375
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001376CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001377 if (!CTUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001378 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001379
Steve Naroff77accc12009-09-03 18:19:54 +00001380 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001381 return createCXString(CXXUnit->getOriginalSourceFileName(), true);
Steve Naroffaf08ddc2009-09-03 15:49:00 +00001382}
Daniel Dunbar1eb79b52009-08-28 16:30:07 +00001383
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00001384CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001385 CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } };
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00001386 return Result;
1387}
1388
Ted Kremenekfb480492010-01-13 21:46:36 +00001389} // end: extern "C"
Steve Naroff600866c2009-08-27 19:51:58 +00001390
Ted Kremenekfb480492010-01-13 21:46:36 +00001391//===----------------------------------------------------------------------===//
Douglas Gregor1db19de2010-01-19 21:36:55 +00001392// CXSourceLocation and CXSourceRange Operations.
1393//===----------------------------------------------------------------------===//
1394
Douglas Gregorb9790342010-01-22 21:44:22 +00001395extern "C" {
1396CXSourceLocation clang_getNullLocation() {
Douglas Gregor5352ac02010-01-28 00:27:43 +00001397 CXSourceLocation Result = { { 0, 0 }, 0 };
Douglas Gregorb9790342010-01-22 21:44:22 +00001398 return Result;
1399}
1400
1401unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) {
Daniel Dunbar90a6b9e2010-01-30 23:58:27 +00001402 return (loc1.ptr_data[0] == loc2.ptr_data[0] &&
1403 loc1.ptr_data[1] == loc2.ptr_data[1] &&
1404 loc1.int_data == loc2.int_data);
Douglas Gregorb9790342010-01-22 21:44:22 +00001405}
1406
1407CXSourceLocation clang_getLocation(CXTranslationUnit tu,
1408 CXFile file,
1409 unsigned line,
1410 unsigned column) {
Douglas Gregor42748ec2010-04-30 19:45:53 +00001411 if (!tu || !file)
Douglas Gregorb9790342010-01-22 21:44:22 +00001412 return clang_getNullLocation();
Douglas Gregor42748ec2010-04-30 19:45:53 +00001413
Douglas Gregorb9790342010-01-22 21:44:22 +00001414 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
1415 SourceLocation SLoc
1416 = CXXUnit->getSourceManager().getLocation(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001417 static_cast<const FileEntry *>(file),
Douglas Gregorb9790342010-01-22 21:44:22 +00001418 line, column);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001419
Ted Kremenekdf432e32010-06-03 15:52:32 +00001420 return SLoc.isInvalid() ?
1421 clang_getNullLocation() :
1422 cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
Douglas Gregorb9790342010-01-22 21:44:22 +00001423}
1424
Douglas Gregor5352ac02010-01-28 00:27:43 +00001425CXSourceRange clang_getNullRange() {
1426 CXSourceRange Result = { { 0, 0 }, 0, 0 };
1427 return Result;
1428}
Daniel Dunbard52864b2010-02-14 10:02:57 +00001429
Douglas Gregor5352ac02010-01-28 00:27:43 +00001430CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) {
1431 if (begin.ptr_data[0] != end.ptr_data[0] ||
1432 begin.ptr_data[1] != end.ptr_data[1])
1433 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001434
1435 CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00001436 begin.int_data, end.int_data };
Douglas Gregorb9790342010-01-22 21:44:22 +00001437 return Result;
1438}
1439
Douglas Gregor46766dc2010-01-26 19:19:08 +00001440void clang_getInstantiationLocation(CXSourceLocation location,
1441 CXFile *file,
1442 unsigned *line,
1443 unsigned *column,
1444 unsigned *offset) {
Douglas Gregor1db19de2010-01-19 21:36:55 +00001445 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
1446
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00001447 if (!location.ptr_data[0] || Loc.isInvalid()) {
Douglas Gregor46766dc2010-01-26 19:19:08 +00001448 if (file)
1449 *file = 0;
1450 if (line)
1451 *line = 0;
1452 if (column)
1453 *column = 0;
1454 if (offset)
1455 *offset = 0;
1456 return;
1457 }
1458
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00001459 const SourceManager &SM =
1460 *static_cast<const SourceManager*>(location.ptr_data[0]);
Douglas Gregor1db19de2010-01-19 21:36:55 +00001461 SourceLocation InstLoc = SM.getInstantiationLoc(Loc);
Douglas Gregor1db19de2010-01-19 21:36:55 +00001462
1463 if (file)
1464 *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc));
1465 if (line)
1466 *line = SM.getInstantiationLineNumber(InstLoc);
1467 if (column)
1468 *column = SM.getInstantiationColumnNumber(InstLoc);
Douglas Gregore69517c2010-01-26 03:07:15 +00001469 if (offset)
Douglas Gregor46766dc2010-01-26 19:19:08 +00001470 *offset = SM.getDecomposedLoc(InstLoc).second;
Douglas Gregore69517c2010-01-26 03:07:15 +00001471}
1472
Douglas Gregor1db19de2010-01-19 21:36:55 +00001473CXSourceLocation clang_getRangeStart(CXSourceRange range) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001474 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00001475 range.begin_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00001476 return Result;
1477}
1478
1479CXSourceLocation clang_getRangeEnd(CXSourceRange range) {
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00001480 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00001481 range.end_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00001482 return Result;
1483}
1484
Douglas Gregorb9790342010-01-22 21:44:22 +00001485} // end: extern "C"
1486
Douglas Gregor1db19de2010-01-19 21:36:55 +00001487//===----------------------------------------------------------------------===//
Ted Kremenekfb480492010-01-13 21:46:36 +00001488// CXFile Operations.
1489//===----------------------------------------------------------------------===//
1490
1491extern "C" {
Ted Kremenek74844072010-02-17 00:41:20 +00001492CXString clang_getFileName(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00001493 if (!SFile)
Ted Kremenek74844072010-02-17 00:41:20 +00001494 return createCXString(NULL);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001495
Steve Naroff88145032009-10-27 14:35:18 +00001496 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
Ted Kremenek74844072010-02-17 00:41:20 +00001497 return createCXString(FEnt->getName());
Steve Naroff88145032009-10-27 14:35:18 +00001498}
1499
1500time_t clang_getFileTime(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00001501 if (!SFile)
1502 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001503
Steve Naroff88145032009-10-27 14:35:18 +00001504 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
1505 return FEnt->getModificationTime();
Steve Naroffee9405e2009-09-25 21:45:39 +00001506}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001507
Douglas Gregorb9790342010-01-22 21:44:22 +00001508CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) {
1509 if (!tu)
1510 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001511
Douglas Gregorb9790342010-01-22 21:44:22 +00001512 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001513
Douglas Gregorb9790342010-01-22 21:44:22 +00001514 FileManager &FMgr = CXXUnit->getFileManager();
1515 const FileEntry *File = FMgr.getFile(file_name, file_name+strlen(file_name));
1516 return const_cast<FileEntry *>(File);
1517}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001518
Ted Kremenekfb480492010-01-13 21:46:36 +00001519} // end: extern "C"
Steve Naroffee9405e2009-09-25 21:45:39 +00001520
Ted Kremenekfb480492010-01-13 21:46:36 +00001521//===----------------------------------------------------------------------===//
1522// CXCursor Operations.
1523//===----------------------------------------------------------------------===//
1524
Ted Kremenekfb480492010-01-13 21:46:36 +00001525static Decl *getDeclFromExpr(Stmt *E) {
1526 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
1527 return RefExpr->getDecl();
1528 if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
1529 return ME->getMemberDecl();
1530 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
1531 return RE->getDecl();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001532
Ted Kremenekfb480492010-01-13 21:46:36 +00001533 if (CallExpr *CE = dyn_cast<CallExpr>(E))
1534 return getDeclFromExpr(CE->getCallee());
1535 if (CastExpr *CE = dyn_cast<CastExpr>(E))
1536 return getDeclFromExpr(CE->getSubExpr());
1537 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
1538 return OME->getMethodDecl();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001539
Ted Kremenekfb480492010-01-13 21:46:36 +00001540 return 0;
1541}
1542
Daniel Dunbarc29f4c32010-02-02 05:00:22 +00001543static SourceLocation getLocationFromExpr(Expr *E) {
1544 if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
1545 return /*FIXME:*/Msg->getLeftLoc();
1546 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
1547 return DRE->getLocation();
1548 if (MemberExpr *Member = dyn_cast<MemberExpr>(E))
1549 return Member->getMemberLoc();
1550 if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
1551 return Ivar->getLocation();
1552 return E->getLocStart();
1553}
1554
Ted Kremenekfb480492010-01-13 21:46:36 +00001555extern "C" {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001556
1557unsigned clang_visitChildren(CXCursor parent,
Douglas Gregorb1373d02010-01-20 20:59:29 +00001558 CXCursorVisitor visitor,
1559 CXClientData client_data) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001560 ASTUnit *CXXUnit = getCursorASTUnit(parent);
Douglas Gregorb1373d02010-01-20 20:59:29 +00001561
1562 unsigned PCHLevel = Decl::MaxPCHLevel;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001563
Douglas Gregorb1373d02010-01-20 20:59:29 +00001564 // Set the PCHLevel to filter out unwanted decls if requested.
1565 if (CXXUnit->getOnlyLocalDecls()) {
1566 PCHLevel = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001567
Douglas Gregorb1373d02010-01-20 20:59:29 +00001568 // If the main input was an AST, bump the level.
1569 if (CXXUnit->isMainFileAST())
1570 ++PCHLevel;
1571 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001572
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001573 CursorVisitor CursorVis(CXXUnit, visitor, client_data, PCHLevel);
Douglas Gregorb1373d02010-01-20 20:59:29 +00001574 return CursorVis.VisitChildren(parent);
1575}
1576
Douglas Gregor78205d42010-01-20 21:45:58 +00001577static CXString getDeclSpelling(Decl *D) {
1578 NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D);
1579 if (!ND)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001580 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001581
Douglas Gregor78205d42010-01-20 21:45:58 +00001582 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001583 return createCXString(OMD->getSelector().getAsString());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001584
Douglas Gregor78205d42010-01-20 21:45:58 +00001585 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
1586 // No, this isn't the same as the code below. getIdentifier() is non-virtual
1587 // and returns different names. NamedDecl returns the class name and
1588 // ObjCCategoryImplDecl returns the category name.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001589 return createCXString(CIMP->getIdentifier()->getNameStart());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001590
Ted Kremenek50aa6ac2010-05-19 21:51:10 +00001591 llvm::SmallString<1024> S;
1592 llvm::raw_svector_ostream os(S);
1593 ND->printName(os);
1594
1595 return createCXString(os.str());
Douglas Gregor78205d42010-01-20 21:45:58 +00001596}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001597
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001598CXString clang_getCursorSpelling(CXCursor C) {
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00001599 if (clang_isTranslationUnit(C.kind))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001600 return clang_getTranslationUnitSpelling(C.data[2]);
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00001601
Steve Narofff334b4e2009-09-02 18:26:48 +00001602 if (clang_isReference(C.kind)) {
1603 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +00001604 case CXCursor_ObjCSuperClassRef: {
Douglas Gregor2e331b92010-01-16 14:00:32 +00001605 ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001606 return createCXString(Super->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00001607 }
1608 case CXCursor_ObjCClassRef: {
Douglas Gregor1adb0822010-01-16 17:14:40 +00001609 ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001610 return createCXString(Class->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00001611 }
1612 case CXCursor_ObjCProtocolRef: {
Douglas Gregor78db0cd2010-01-16 15:44:18 +00001613 ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
Douglas Gregorf46034a2010-01-18 23:41:10 +00001614 assert(OID && "getCursorSpelling(): Missing protocol decl");
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001615 return createCXString(OID->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00001616 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001617 case CXCursor_TypeRef: {
1618 TypeDecl *Type = getCursorTypeRef(C).first;
1619 assert(Type && "Missing type decl");
1620
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001621 return createCXString(getCursorContext(C).getTypeDeclType(Type).
1622 getAsString());
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001623 }
1624
Daniel Dunbaracca7252009-11-30 20:42:49 +00001625 default:
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001626 return createCXString("<not implemented>");
Steve Narofff334b4e2009-09-02 18:26:48 +00001627 }
1628 }
Douglas Gregor97b98722010-01-19 23:20:36 +00001629
1630 if (clang_isExpression(C.kind)) {
1631 Decl *D = getDeclFromExpr(getCursorExpr(C));
1632 if (D)
Douglas Gregor78205d42010-01-20 21:45:58 +00001633 return getDeclSpelling(D);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001634 return createCXString("");
Douglas Gregor97b98722010-01-19 23:20:36 +00001635 }
1636
Douglas Gregor4ae8f292010-03-18 17:52:52 +00001637 if (C.kind == CXCursor_MacroInstantiation)
1638 return createCXString(getCursorMacroInstantiation(C)->getName()
1639 ->getNameStart());
1640
Douglas Gregor572feb22010-03-18 18:04:21 +00001641 if (C.kind == CXCursor_MacroDefinition)
1642 return createCXString(getCursorMacroDefinition(C)->getName()
1643 ->getNameStart());
1644
Douglas Gregor60cbfac2010-01-25 16:56:17 +00001645 if (clang_isDeclaration(C.kind))
1646 return getDeclSpelling(getCursorDecl(C));
Ted Kremeneke68fff62010-02-17 00:41:32 +00001647
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001648 return createCXString("");
Steve Narofff334b4e2009-09-02 18:26:48 +00001649}
1650
Ted Kremeneke68fff62010-02-17 00:41:32 +00001651CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
Steve Naroff89922f82009-08-31 00:59:03 +00001652 switch (Kind) {
Ted Kremeneke68fff62010-02-17 00:41:32 +00001653 case CXCursor_FunctionDecl:
1654 return createCXString("FunctionDecl");
1655 case CXCursor_TypedefDecl:
1656 return createCXString("TypedefDecl");
1657 case CXCursor_EnumDecl:
1658 return createCXString("EnumDecl");
1659 case CXCursor_EnumConstantDecl:
1660 return createCXString("EnumConstantDecl");
1661 case CXCursor_StructDecl:
1662 return createCXString("StructDecl");
1663 case CXCursor_UnionDecl:
1664 return createCXString("UnionDecl");
1665 case CXCursor_ClassDecl:
1666 return createCXString("ClassDecl");
1667 case CXCursor_FieldDecl:
1668 return createCXString("FieldDecl");
1669 case CXCursor_VarDecl:
1670 return createCXString("VarDecl");
1671 case CXCursor_ParmDecl:
1672 return createCXString("ParmDecl");
1673 case CXCursor_ObjCInterfaceDecl:
1674 return createCXString("ObjCInterfaceDecl");
1675 case CXCursor_ObjCCategoryDecl:
1676 return createCXString("ObjCCategoryDecl");
1677 case CXCursor_ObjCProtocolDecl:
1678 return createCXString("ObjCProtocolDecl");
1679 case CXCursor_ObjCPropertyDecl:
1680 return createCXString("ObjCPropertyDecl");
1681 case CXCursor_ObjCIvarDecl:
1682 return createCXString("ObjCIvarDecl");
1683 case CXCursor_ObjCInstanceMethodDecl:
1684 return createCXString("ObjCInstanceMethodDecl");
1685 case CXCursor_ObjCClassMethodDecl:
1686 return createCXString("ObjCClassMethodDecl");
1687 case CXCursor_ObjCImplementationDecl:
1688 return createCXString("ObjCImplementationDecl");
1689 case CXCursor_ObjCCategoryImplDecl:
1690 return createCXString("ObjCCategoryImplDecl");
Ted Kremenek8bd5a692010-04-13 23:39:06 +00001691 case CXCursor_CXXMethod:
1692 return createCXString("CXXMethod");
Ted Kremeneke68fff62010-02-17 00:41:32 +00001693 case CXCursor_UnexposedDecl:
1694 return createCXString("UnexposedDecl");
1695 case CXCursor_ObjCSuperClassRef:
1696 return createCXString("ObjCSuperClassRef");
1697 case CXCursor_ObjCProtocolRef:
1698 return createCXString("ObjCProtocolRef");
1699 case CXCursor_ObjCClassRef:
1700 return createCXString("ObjCClassRef");
1701 case CXCursor_TypeRef:
1702 return createCXString("TypeRef");
1703 case CXCursor_UnexposedExpr:
1704 return createCXString("UnexposedExpr");
Ted Kremenek1ee6cad2010-04-11 21:47:37 +00001705 case CXCursor_BlockExpr:
1706 return createCXString("BlockExpr");
Ted Kremeneke68fff62010-02-17 00:41:32 +00001707 case CXCursor_DeclRefExpr:
1708 return createCXString("DeclRefExpr");
1709 case CXCursor_MemberRefExpr:
1710 return createCXString("MemberRefExpr");
1711 case CXCursor_CallExpr:
1712 return createCXString("CallExpr");
1713 case CXCursor_ObjCMessageExpr:
1714 return createCXString("ObjCMessageExpr");
1715 case CXCursor_UnexposedStmt:
1716 return createCXString("UnexposedStmt");
1717 case CXCursor_InvalidFile:
1718 return createCXString("InvalidFile");
Ted Kremenek292db642010-03-19 20:39:05 +00001719 case CXCursor_InvalidCode:
1720 return createCXString("InvalidCode");
Ted Kremeneke68fff62010-02-17 00:41:32 +00001721 case CXCursor_NoDeclFound:
1722 return createCXString("NoDeclFound");
1723 case CXCursor_NotImplemented:
1724 return createCXString("NotImplemented");
1725 case CXCursor_TranslationUnit:
1726 return createCXString("TranslationUnit");
Ted Kremeneke77f4432010-02-18 03:09:07 +00001727 case CXCursor_UnexposedAttr:
1728 return createCXString("UnexposedAttr");
1729 case CXCursor_IBActionAttr:
1730 return createCXString("attribute(ibaction)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001731 case CXCursor_IBOutletAttr:
1732 return createCXString("attribute(iboutlet)");
Ted Kremenek857e9182010-05-19 17:38:06 +00001733 case CXCursor_IBOutletCollectionAttr:
1734 return createCXString("attribute(iboutletcollection)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001735 case CXCursor_PreprocessingDirective:
1736 return createCXString("preprocessing directive");
Douglas Gregor572feb22010-03-18 18:04:21 +00001737 case CXCursor_MacroDefinition:
1738 return createCXString("macro definition");
Douglas Gregor48072312010-03-18 15:23:44 +00001739 case CXCursor_MacroInstantiation:
1740 return createCXString("macro instantiation");
Ted Kremenek8f06e0e2010-05-06 23:38:21 +00001741 case CXCursor_Namespace:
1742 return createCXString("Namespace");
Ted Kremeneka0536d82010-05-07 01:04:29 +00001743 case CXCursor_LinkageSpec:
1744 return createCXString("LinkageSpec");
Steve Naroff89922f82009-08-31 00:59:03 +00001745 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001746
Ted Kremenekdeb06bd2010-01-16 02:02:09 +00001747 llvm_unreachable("Unhandled CXCursorKind");
Ted Kremeneke68fff62010-02-17 00:41:32 +00001748 return createCXString(NULL);
Steve Naroff600866c2009-08-27 19:51:58 +00001749}
Steve Naroff89922f82009-08-31 00:59:03 +00001750
Ted Kremeneke68fff62010-02-17 00:41:32 +00001751enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
1752 CXCursor parent,
Douglas Gregor33e9abd2010-01-22 19:49:59 +00001753 CXClientData client_data) {
1754 CXCursor *BestCursor = static_cast<CXCursor *>(client_data);
1755 *BestCursor = cursor;
1756 return CXChildVisit_Recurse;
1757}
Ted Kremeneke68fff62010-02-17 00:41:32 +00001758
Douglas Gregorb9790342010-01-22 21:44:22 +00001759CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
1760 if (!TU)
Ted Kremenekf4629892010-01-14 01:51:23 +00001761 return clang_getNullCursor();
Ted Kremeneke68fff62010-02-17 00:41:32 +00001762
Douglas Gregorb9790342010-01-22 21:44:22 +00001763 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
1764
Douglas Gregorbdf60622010-03-05 21:16:25 +00001765 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
1766
Ted Kremeneka297de22010-01-25 22:34:44 +00001767 SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
Douglas Gregor33e9abd2010-01-22 19:49:59 +00001768 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
1769 if (SLoc.isValid()) {
Daniel Dunbard52864b2010-02-14 10:02:57 +00001770 SourceRange RegionOfInterest(SLoc, SLoc.getFileLocWithOffset(1));
Ted Kremeneke68fff62010-02-17 00:41:32 +00001771
Douglas Gregor33e9abd2010-01-22 19:49:59 +00001772 // FIXME: Would be great to have a "hint" cursor, then walk from that
1773 // hint cursor upward until we find a cursor whose source range encloses
1774 // the region of interest, rather than starting from the translation unit.
1775 CXCursor Parent = clang_getTranslationUnitCursor(CXXUnit);
Ted Kremeneke68fff62010-02-17 00:41:32 +00001776 CursorVisitor CursorVis(CXXUnit, GetCursorVisitor, &Result,
Douglas Gregor33e9abd2010-01-22 19:49:59 +00001777 Decl::MaxPCHLevel, RegionOfInterest);
1778 CursorVis.VisitChildren(Parent);
Steve Naroff77128dd2009-09-15 20:25:34 +00001779 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001780 return Result;
Steve Naroff600866c2009-08-27 19:51:58 +00001781}
1782
Ted Kremenek73885552009-11-17 19:28:59 +00001783CXCursor clang_getNullCursor(void) {
Douglas Gregor5bfb8c12010-01-20 23:34:41 +00001784 return MakeCXCursorInvalid(CXCursor_InvalidFile);
Ted Kremenek73885552009-11-17 19:28:59 +00001785}
1786
1787unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
Douglas Gregor283cae32010-01-15 21:56:13 +00001788 return X == Y;
Ted Kremenek73885552009-11-17 19:28:59 +00001789}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001790
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001791unsigned clang_isInvalid(enum CXCursorKind K) {
Steve Naroff77128dd2009-09-15 20:25:34 +00001792 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
1793}
1794
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001795unsigned clang_isDeclaration(enum CXCursorKind K) {
Steve Naroff89922f82009-08-31 00:59:03 +00001796 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
1797}
Steve Naroff2d4d6292009-08-31 14:26:51 +00001798
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001799unsigned clang_isReference(enum CXCursorKind K) {
Steve Narofff334b4e2009-09-02 18:26:48 +00001800 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
1801}
1802
Douglas Gregor97b98722010-01-19 23:20:36 +00001803unsigned clang_isExpression(enum CXCursorKind K) {
1804 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
1805}
1806
1807unsigned clang_isStatement(enum CXCursorKind K) {
1808 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
1809}
1810
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00001811unsigned clang_isTranslationUnit(enum CXCursorKind K) {
1812 return K == CXCursor_TranslationUnit;
1813}
1814
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001815unsigned clang_isPreprocessing(enum CXCursorKind K) {
1816 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
1817}
1818
Ted Kremenekad6eff62010-03-08 21:17:29 +00001819unsigned clang_isUnexposed(enum CXCursorKind K) {
1820 switch (K) {
1821 case CXCursor_UnexposedDecl:
1822 case CXCursor_UnexposedExpr:
1823 case CXCursor_UnexposedStmt:
1824 case CXCursor_UnexposedAttr:
1825 return true;
1826 default:
1827 return false;
1828 }
1829}
1830
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001831CXCursorKind clang_getCursorKind(CXCursor C) {
Steve Naroff9efa7672009-09-04 15:44:05 +00001832 return C.kind;
1833}
1834
Douglas Gregor98258af2010-01-18 22:46:11 +00001835CXSourceLocation clang_getCursorLocation(CXCursor C) {
1836 if (clang_isReference(C.kind)) {
Douglas Gregorf46034a2010-01-18 23:41:10 +00001837 switch (C.kind) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001838 case CXCursor_ObjCSuperClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00001839 std::pair<ObjCInterfaceDecl *, SourceLocation> P
1840 = getCursorObjCSuperClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00001841 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001842 }
1843
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001844 case CXCursor_ObjCProtocolRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00001845 std::pair<ObjCProtocolDecl *, SourceLocation> P
1846 = getCursorObjCProtocolRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00001847 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001848 }
1849
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001850 case CXCursor_ObjCClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00001851 std::pair<ObjCInterfaceDecl *, SourceLocation> P
1852 = getCursorObjCClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00001853 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001854 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001855
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001856 case CXCursor_TypeRef: {
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001857 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00001858 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001859 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001860
Douglas Gregorf46034a2010-01-18 23:41:10 +00001861 default:
1862 // FIXME: Need a way to enumerate all non-reference cases.
1863 llvm_unreachable("Missed a reference kind");
1864 }
Douglas Gregor98258af2010-01-18 22:46:11 +00001865 }
Douglas Gregor97b98722010-01-19 23:20:36 +00001866
1867 if (clang_isExpression(C.kind))
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001868 return cxloc::translateSourceLocation(getCursorContext(C),
Douglas Gregor97b98722010-01-19 23:20:36 +00001869 getLocationFromExpr(getCursorExpr(C)));
1870
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001871 if (C.kind == CXCursor_PreprocessingDirective) {
1872 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
1873 return cxloc::translateSourceLocation(getCursorContext(C), L);
1874 }
Douglas Gregor48072312010-03-18 15:23:44 +00001875
1876 if (C.kind == CXCursor_MacroInstantiation) {
Douglas Gregor4ae8f292010-03-18 17:52:52 +00001877 SourceLocation L
1878 = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin();
Douglas Gregor48072312010-03-18 15:23:44 +00001879 return cxloc::translateSourceLocation(getCursorContext(C), L);
1880 }
Douglas Gregor572feb22010-03-18 18:04:21 +00001881
1882 if (C.kind == CXCursor_MacroDefinition) {
1883 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
1884 return cxloc::translateSourceLocation(getCursorContext(C), L);
1885 }
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001886
Ted Kremenek9a700d22010-05-12 06:16:13 +00001887 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
Douglas Gregor5352ac02010-01-28 00:27:43 +00001888 return clang_getNullLocation();
Douglas Gregor98258af2010-01-18 22:46:11 +00001889
Douglas Gregorf46034a2010-01-18 23:41:10 +00001890 Decl *D = getCursorDecl(C);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001891 SourceLocation Loc = D->getLocation();
1892 if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D))
1893 Loc = Class->getClassLoc();
Douglas Gregor2ca54fe2010-03-22 15:53:50 +00001894 return cxloc::translateSourceLocation(getCursorContext(C), Loc);
Douglas Gregor98258af2010-01-18 22:46:11 +00001895}
Douglas Gregora7bde202010-01-19 00:34:46 +00001896
1897CXSourceRange clang_getCursorExtent(CXCursor C) {
1898 if (clang_isReference(C.kind)) {
1899 switch (C.kind) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001900 case CXCursor_ObjCSuperClassRef: {
Douglas Gregora7bde202010-01-19 00:34:46 +00001901 std::pair<ObjCInterfaceDecl *, SourceLocation> P
1902 = getCursorObjCSuperClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00001903 return cxloc::translateSourceRange(P.first->getASTContext(), P.second);
Douglas Gregora7bde202010-01-19 00:34:46 +00001904 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001905
1906 case CXCursor_ObjCProtocolRef: {
Douglas Gregora7bde202010-01-19 00:34:46 +00001907 std::pair<ObjCProtocolDecl *, SourceLocation> P
1908 = getCursorObjCProtocolRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00001909 return cxloc::translateSourceRange(P.first->getASTContext(), P.second);
Douglas Gregora7bde202010-01-19 00:34:46 +00001910 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001911
1912 case CXCursor_ObjCClassRef: {
Douglas Gregora7bde202010-01-19 00:34:46 +00001913 std::pair<ObjCInterfaceDecl *, SourceLocation> P
1914 = getCursorObjCClassRef(C);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001915
Ted Kremeneka297de22010-01-25 22:34:44 +00001916 return cxloc::translateSourceRange(P.first->getASTContext(), P.second);
Douglas Gregora7bde202010-01-19 00:34:46 +00001917 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001918
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001919 case CXCursor_TypeRef: {
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001920 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00001921 return cxloc::translateSourceRange(P.first->getASTContext(), P.second);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001922 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001923
Douglas Gregora7bde202010-01-19 00:34:46 +00001924 default:
1925 // FIXME: Need a way to enumerate all non-reference cases.
1926 llvm_unreachable("Missed a reference kind");
1927 }
1928 }
Douglas Gregor97b98722010-01-19 23:20:36 +00001929
1930 if (clang_isExpression(C.kind))
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001931 return cxloc::translateSourceRange(getCursorContext(C),
Douglas Gregor97b98722010-01-19 23:20:36 +00001932 getCursorExpr(C)->getSourceRange());
Douglas Gregor33e9abd2010-01-22 19:49:59 +00001933
1934 if (clang_isStatement(C.kind))
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001935 return cxloc::translateSourceRange(getCursorContext(C),
Douglas Gregor33e9abd2010-01-22 19:49:59 +00001936 getCursorStmt(C)->getSourceRange());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001937
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001938 if (C.kind == CXCursor_PreprocessingDirective) {
1939 SourceRange R = cxcursor::getCursorPreprocessingDirective(C);
1940 return cxloc::translateSourceRange(getCursorContext(C), R);
1941 }
Douglas Gregor48072312010-03-18 15:23:44 +00001942
1943 if (C.kind == CXCursor_MacroInstantiation) {
Douglas Gregor4ae8f292010-03-18 17:52:52 +00001944 SourceRange R = cxcursor::getCursorMacroInstantiation(C)->getSourceRange();
Douglas Gregor48072312010-03-18 15:23:44 +00001945 return cxloc::translateSourceRange(getCursorContext(C), R);
1946 }
Douglas Gregor572feb22010-03-18 18:04:21 +00001947
1948 if (C.kind == CXCursor_MacroDefinition) {
1949 SourceRange R = cxcursor::getCursorMacroDefinition(C)->getSourceRange();
1950 return cxloc::translateSourceRange(getCursorContext(C), R);
1951 }
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001952
Ted Kremenek9a700d22010-05-12 06:16:13 +00001953 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
Douglas Gregor5352ac02010-01-28 00:27:43 +00001954 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001955
Douglas Gregora7bde202010-01-19 00:34:46 +00001956 Decl *D = getCursorDecl(C);
Douglas Gregor2ca54fe2010-03-22 15:53:50 +00001957 return cxloc::translateSourceRange(getCursorContext(C), D->getSourceRange());
Douglas Gregora7bde202010-01-19 00:34:46 +00001958}
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001959
1960CXCursor clang_getCursorReferenced(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001961 if (clang_isInvalid(C.kind))
1962 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001963
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001964 ASTUnit *CXXUnit = getCursorASTUnit(C);
Douglas Gregorb6998662010-01-19 19:34:47 +00001965 if (clang_isDeclaration(C.kind))
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001966 return C;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001967
Douglas Gregor97b98722010-01-19 23:20:36 +00001968 if (clang_isExpression(C.kind)) {
1969 Decl *D = getDeclFromExpr(getCursorExpr(C));
1970 if (D)
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001971 return MakeCXCursor(D, CXXUnit);
Douglas Gregor97b98722010-01-19 23:20:36 +00001972 return clang_getNullCursor();
1973 }
1974
Douglas Gregorbf7efa22010-03-18 18:23:03 +00001975 if (C.kind == CXCursor_MacroInstantiation) {
1976 if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition())
1977 return MakeMacroDefinitionCursor(Def, CXXUnit);
1978 }
1979
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001980 if (!clang_isReference(C.kind))
1981 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001982
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001983 switch (C.kind) {
1984 case CXCursor_ObjCSuperClassRef:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001985 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, CXXUnit);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001986
1987 case CXCursor_ObjCProtocolRef: {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001988 return MakeCXCursor(getCursorObjCProtocolRef(C).first, CXXUnit);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001989
1990 case CXCursor_ObjCClassRef:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001991 return MakeCXCursor(getCursorObjCClassRef(C).first, CXXUnit);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001992
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001993 case CXCursor_TypeRef:
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001994 return MakeCXCursor(getCursorTypeRef(C).first, CXXUnit);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001995
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001996 default:
1997 // We would prefer to enumerate all non-reference cursor kinds here.
1998 llvm_unreachable("Unhandled reference cursor kind");
1999 break;
2000 }
2001 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002002
Douglas Gregorc5d1e932010-01-19 01:20:04 +00002003 return clang_getNullCursor();
2004}
2005
Douglas Gregorb6998662010-01-19 19:34:47 +00002006CXCursor clang_getCursorDefinition(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002007 if (clang_isInvalid(C.kind))
2008 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002009
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002010 ASTUnit *CXXUnit = getCursorASTUnit(C);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002011
Douglas Gregorb6998662010-01-19 19:34:47 +00002012 bool WasReference = false;
Douglas Gregor97b98722010-01-19 23:20:36 +00002013 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
Douglas Gregorb6998662010-01-19 19:34:47 +00002014 C = clang_getCursorReferenced(C);
2015 WasReference = true;
2016 }
2017
Douglas Gregorbf7efa22010-03-18 18:23:03 +00002018 if (C.kind == CXCursor_MacroInstantiation)
2019 return clang_getCursorReferenced(C);
2020
Douglas Gregorb6998662010-01-19 19:34:47 +00002021 if (!clang_isDeclaration(C.kind))
2022 return clang_getNullCursor();
2023
2024 Decl *D = getCursorDecl(C);
2025 if (!D)
2026 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002027
Douglas Gregorb6998662010-01-19 19:34:47 +00002028 switch (D->getKind()) {
2029 // Declaration kinds that don't really separate the notions of
2030 // declaration and definition.
2031 case Decl::Namespace:
2032 case Decl::Typedef:
2033 case Decl::TemplateTypeParm:
2034 case Decl::EnumConstant:
2035 case Decl::Field:
2036 case Decl::ObjCIvar:
2037 case Decl::ObjCAtDefsField:
2038 case Decl::ImplicitParam:
2039 case Decl::ParmVar:
2040 case Decl::NonTypeTemplateParm:
2041 case Decl::TemplateTemplateParm:
2042 case Decl::ObjCCategoryImpl:
2043 case Decl::ObjCImplementation:
Abramo Bagnara6206d532010-06-05 05:09:32 +00002044 case Decl::AccessSpec:
Douglas Gregorb6998662010-01-19 19:34:47 +00002045 case Decl::LinkageSpec:
2046 case Decl::ObjCPropertyImpl:
2047 case Decl::FileScopeAsm:
2048 case Decl::StaticAssert:
2049 case Decl::Block:
2050 return C;
2051
2052 // Declaration kinds that don't make any sense here, but are
2053 // nonetheless harmless.
2054 case Decl::TranslationUnit:
Douglas Gregorb6998662010-01-19 19:34:47 +00002055 break;
2056
2057 // Declaration kinds for which the definition is not resolvable.
2058 case Decl::UnresolvedUsingTypename:
2059 case Decl::UnresolvedUsingValue:
2060 break;
2061
2062 case Decl::UsingDirective:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002063 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
2064 CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002065
2066 case Decl::NamespaceAlias:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002067 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002068
2069 case Decl::Enum:
2070 case Decl::Record:
2071 case Decl::CXXRecord:
2072 case Decl::ClassTemplateSpecialization:
2073 case Decl::ClassTemplatePartialSpecialization:
Douglas Gregor952b0172010-02-11 01:04:33 +00002074 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002075 return MakeCXCursor(Def, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002076 return clang_getNullCursor();
2077
2078 case Decl::Function:
2079 case Decl::CXXMethod:
2080 case Decl::CXXConstructor:
2081 case Decl::CXXDestructor:
2082 case Decl::CXXConversion: {
2083 const FunctionDecl *Def = 0;
2084 if (cast<FunctionDecl>(D)->getBody(Def))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002085 return MakeCXCursor(const_cast<FunctionDecl *>(Def), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002086 return clang_getNullCursor();
2087 }
2088
2089 case Decl::Var: {
Sebastian Redl31310a22010-02-01 20:16:42 +00002090 // Ask the variable if it has a definition.
2091 if (VarDecl *Def = cast<VarDecl>(D)->getDefinition())
2092 return MakeCXCursor(Def, CXXUnit);
2093 return clang_getNullCursor();
Douglas Gregorb6998662010-01-19 19:34:47 +00002094 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002095
Douglas Gregorb6998662010-01-19 19:34:47 +00002096 case Decl::FunctionTemplate: {
2097 const FunctionDecl *Def = 0;
2098 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002099 return MakeCXCursor(Def->getDescribedFunctionTemplate(), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002100 return clang_getNullCursor();
2101 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002102
Douglas Gregorb6998662010-01-19 19:34:47 +00002103 case Decl::ClassTemplate: {
2104 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
Douglas Gregor952b0172010-02-11 01:04:33 +00002105 ->getDefinition())
Douglas Gregorb6998662010-01-19 19:34:47 +00002106 return MakeCXCursor(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002107 cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002108 CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002109 return clang_getNullCursor();
2110 }
2111
2112 case Decl::Using: {
2113 UsingDecl *Using = cast<UsingDecl>(D);
2114 CXCursor Def = clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002115 for (UsingDecl::shadow_iterator S = Using->shadow_begin(),
2116 SEnd = Using->shadow_end();
Douglas Gregorb6998662010-01-19 19:34:47 +00002117 S != SEnd; ++S) {
2118 if (Def != clang_getNullCursor()) {
2119 // FIXME: We have no way to return multiple results.
2120 return clang_getNullCursor();
2121 }
2122
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002123 Def = clang_getCursorDefinition(MakeCXCursor((*S)->getTargetDecl(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002124 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00002125 }
2126
2127 return Def;
2128 }
2129
2130 case Decl::UsingShadow:
2131 return clang_getCursorDefinition(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002132 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002133 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00002134
2135 case Decl::ObjCMethod: {
2136 ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
2137 if (Method->isThisDeclarationADefinition())
2138 return C;
2139
2140 // Dig out the method definition in the associated
2141 // @implementation, if we have it.
2142 // FIXME: The ASTs should make finding the definition easier.
2143 if (ObjCInterfaceDecl *Class
2144 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
2145 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
2146 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
2147 Method->isInstanceMethod()))
2148 if (Def->isThisDeclarationADefinition())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002149 return MakeCXCursor(Def, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002150
2151 return clang_getNullCursor();
2152 }
2153
2154 case Decl::ObjCCategory:
2155 if (ObjCCategoryImplDecl *Impl
2156 = cast<ObjCCategoryDecl>(D)->getImplementation())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002157 return MakeCXCursor(Impl, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002158 return clang_getNullCursor();
2159
2160 case Decl::ObjCProtocol:
2161 if (!cast<ObjCProtocolDecl>(D)->isForwardDecl())
2162 return C;
2163 return clang_getNullCursor();
2164
2165 case Decl::ObjCInterface:
2166 // There are two notions of a "definition" for an Objective-C
2167 // class: the interface and its implementation. When we resolved a
2168 // reference to an Objective-C class, produce the @interface as
2169 // the definition; when we were provided with the interface,
2170 // produce the @implementation as the definition.
2171 if (WasReference) {
2172 if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl())
2173 return C;
2174 } else if (ObjCImplementationDecl *Impl
2175 = cast<ObjCInterfaceDecl>(D)->getImplementation())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002176 return MakeCXCursor(Impl, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002177 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002178
Douglas Gregorb6998662010-01-19 19:34:47 +00002179 case Decl::ObjCProperty:
2180 // FIXME: We don't really know where to find the
2181 // ObjCPropertyImplDecls that implement this property.
2182 return clang_getNullCursor();
2183
2184 case Decl::ObjCCompatibleAlias:
2185 if (ObjCInterfaceDecl *Class
2186 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
2187 if (!Class->isForwardDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002188 return MakeCXCursor(Class, CXXUnit);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002189
Douglas Gregorb6998662010-01-19 19:34:47 +00002190 return clang_getNullCursor();
2191
2192 case Decl::ObjCForwardProtocol: {
2193 ObjCForwardProtocolDecl *Forward = cast<ObjCForwardProtocolDecl>(D);
2194 if (Forward->protocol_size() == 1)
2195 return clang_getCursorDefinition(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002196 MakeCXCursor(*Forward->protocol_begin(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002197 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00002198
2199 // FIXME: Cannot return multiple definitions.
2200 return clang_getNullCursor();
2201 }
2202
2203 case Decl::ObjCClass: {
2204 ObjCClassDecl *Class = cast<ObjCClassDecl>(D);
2205 if (Class->size() == 1) {
2206 ObjCInterfaceDecl *IFace = Class->begin()->getInterface();
2207 if (!IFace->isForwardDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002208 return MakeCXCursor(IFace, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002209 return clang_getNullCursor();
2210 }
2211
2212 // FIXME: Cannot return multiple definitions.
2213 return clang_getNullCursor();
2214 }
2215
2216 case Decl::Friend:
2217 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002218 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00002219 return clang_getNullCursor();
2220
2221 case Decl::FriendTemplate:
2222 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002223 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00002224 return clang_getNullCursor();
2225 }
2226
2227 return clang_getNullCursor();
2228}
2229
2230unsigned clang_isCursorDefinition(CXCursor C) {
2231 if (!clang_isDeclaration(C.kind))
2232 return 0;
2233
2234 return clang_getCursorDefinition(C) == C;
2235}
2236
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002237void clang_getDefinitionSpellingAndExtent(CXCursor C,
Steve Naroff4ade6d62009-09-23 17:52:52 +00002238 const char **startBuf,
2239 const char **endBuf,
2240 unsigned *startLine,
2241 unsigned *startColumn,
2242 unsigned *endLine,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002243 unsigned *endColumn) {
Douglas Gregor283cae32010-01-15 21:56:13 +00002244 assert(getCursorDecl(C) && "CXCursor has null decl");
2245 NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C));
Steve Naroff4ade6d62009-09-23 17:52:52 +00002246 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
2247 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002248
Steve Naroff4ade6d62009-09-23 17:52:52 +00002249 SourceManager &SM = FD->getASTContext().getSourceManager();
2250 *startBuf = SM.getCharacterData(Body->getLBracLoc());
2251 *endBuf = SM.getCharacterData(Body->getRBracLoc());
2252 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
2253 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
2254 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
2255 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
2256}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002257
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002258void clang_enableStackTraces(void) {
2259 llvm::sys::PrintStackTraceOnErrorSignal();
2260}
2261
Ted Kremenekfb480492010-01-13 21:46:36 +00002262} // end: extern "C"
Steve Naroff4ade6d62009-09-23 17:52:52 +00002263
Ted Kremenekfb480492010-01-13 21:46:36 +00002264//===----------------------------------------------------------------------===//
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002265// Token-based Operations.
2266//===----------------------------------------------------------------------===//
2267
2268/* CXToken layout:
2269 * int_data[0]: a CXTokenKind
2270 * int_data[1]: starting token location
2271 * int_data[2]: token length
2272 * int_data[3]: reserved
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002273 * ptr_data: for identifiers and keywords, an IdentifierInfo*.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002274 * otherwise unused.
2275 */
2276extern "C" {
2277
2278CXTokenKind clang_getTokenKind(CXToken CXTok) {
2279 return static_cast<CXTokenKind>(CXTok.int_data[0]);
2280}
2281
2282CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
2283 switch (clang_getTokenKind(CXTok)) {
2284 case CXToken_Identifier:
2285 case CXToken_Keyword:
2286 // We know we have an IdentifierInfo*, so use that.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002287 return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data)
2288 ->getNameStart());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002289
2290 case CXToken_Literal: {
2291 // We have stashed the starting pointer in the ptr_data field. Use it.
2292 const char *Text = static_cast<const char *>(CXTok.ptr_data);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002293 return createCXString(llvm::StringRef(Text, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002294 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002295
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002296 case CXToken_Punctuation:
2297 case CXToken_Comment:
2298 break;
2299 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002300
2301 // We have to find the starting buffer pointer the hard way, by
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002302 // deconstructing the source location.
2303 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2304 if (!CXXUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002305 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002306
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002307 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
2308 std::pair<FileID, unsigned> LocInfo
2309 = CXXUnit->getSourceManager().getDecomposedLoc(Loc);
Douglas Gregorf715ca12010-03-16 00:06:06 +00002310 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002311 llvm::StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00002312 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
2313 if (Invalid)
Douglas Gregoraea67db2010-03-15 22:54:52 +00002314 return createCXString("");
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002315
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002316 return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002317}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002318
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002319CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
2320 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2321 if (!CXXUnit)
2322 return clang_getNullLocation();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002323
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002324 return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
2325 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
2326}
2327
2328CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
2329 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
Douglas Gregor5352ac02010-01-28 00:27:43 +00002330 if (!CXXUnit)
2331 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002332
2333 return cxloc::translateSourceRange(CXXUnit->getASTContext(),
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002334 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
2335}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002336
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002337void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
2338 CXToken **Tokens, unsigned *NumTokens) {
2339 if (Tokens)
2340 *Tokens = 0;
2341 if (NumTokens)
2342 *NumTokens = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002343
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002344 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2345 if (!CXXUnit || !Tokens || !NumTokens)
2346 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002347
Douglas Gregorbdf60622010-03-05 21:16:25 +00002348 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
2349
Daniel Dunbar85b988f2010-02-14 08:31:57 +00002350 SourceRange R = cxloc::translateCXSourceRange(Range);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002351 if (R.isInvalid())
2352 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002353
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002354 SourceManager &SourceMgr = CXXUnit->getSourceManager();
2355 std::pair<FileID, unsigned> BeginLocInfo
2356 = SourceMgr.getDecomposedLoc(R.getBegin());
2357 std::pair<FileID, unsigned> EndLocInfo
2358 = SourceMgr.getDecomposedLoc(R.getEnd());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002359
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002360 // Cannot tokenize across files.
2361 if (BeginLocInfo.first != EndLocInfo.first)
2362 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002363
2364 // Create a lexer
Douglas Gregorf715ca12010-03-16 00:06:06 +00002365 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002366 llvm::StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00002367 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
Douglas Gregor47a3fcd2010-03-16 20:26:15 +00002368 if (Invalid)
2369 return;
Douglas Gregoraea67db2010-03-15 22:54:52 +00002370
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002371 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
2372 CXXUnit->getASTContext().getLangOptions(),
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002373 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002374 Lex.SetCommentRetentionState(true);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002375
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002376 // Lex tokens until we hit the end of the range.
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002377 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002378 llvm::SmallVector<CXToken, 32> CXTokens;
2379 Token Tok;
2380 do {
2381 // Lex the next token
2382 Lex.LexFromRawLexer(Tok);
2383 if (Tok.is(tok::eof))
2384 break;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002385
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002386 // Initialize the CXToken.
2387 CXToken CXTok;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002388
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002389 // - Common fields
2390 CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
2391 CXTok.int_data[2] = Tok.getLength();
2392 CXTok.int_data[3] = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002393
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002394 // - Kind-specific fields
2395 if (Tok.isLiteral()) {
2396 CXTok.int_data[0] = CXToken_Literal;
2397 CXTok.ptr_data = (void *)Tok.getLiteralData();
2398 } else if (Tok.is(tok::identifier)) {
Douglas Gregoraea67db2010-03-15 22:54:52 +00002399 // Lookup the identifier to determine whether we have a keyword.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002400 std::pair<FileID, unsigned> LocInfo
2401 = SourceMgr.getDecomposedLoc(Tok.getLocation());
Douglas Gregorf715ca12010-03-16 00:06:06 +00002402 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002403 llvm::StringRef Buf
Douglas Gregorf715ca12010-03-16 00:06:06 +00002404 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
2405 if (Invalid)
Douglas Gregoraea67db2010-03-15 22:54:52 +00002406 return;
2407
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002408 const char *StartPos = Buf.data() + LocInfo.second;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002409 IdentifierInfo *II
2410 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok, StartPos);
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00002411
2412 if (II->getObjCKeywordID() != tok::objc_not_keyword) {
2413 CXTok.int_data[0] = CXToken_Keyword;
2414 }
2415 else {
2416 CXTok.int_data[0] = II->getTokenID() == tok::identifier?
2417 CXToken_Identifier
2418 : CXToken_Keyword;
2419 }
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002420 CXTok.ptr_data = II;
2421 } else if (Tok.is(tok::comment)) {
2422 CXTok.int_data[0] = CXToken_Comment;
2423 CXTok.ptr_data = 0;
2424 } else {
2425 CXTok.int_data[0] = CXToken_Punctuation;
2426 CXTok.ptr_data = 0;
2427 }
2428 CXTokens.push_back(CXTok);
2429 } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002430
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002431 if (CXTokens.empty())
2432 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002433
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002434 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
2435 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
2436 *NumTokens = CXTokens.size();
2437}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002438
Ted Kremenek6db61092010-05-05 00:55:15 +00002439void clang_disposeTokens(CXTranslationUnit TU,
2440 CXToken *Tokens, unsigned NumTokens) {
2441 free(Tokens);
2442}
2443
2444} // end: extern "C"
2445
2446//===----------------------------------------------------------------------===//
2447// Token annotation APIs.
2448//===----------------------------------------------------------------------===//
2449
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002450typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002451static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
2452 CXCursor parent,
2453 CXClientData client_data);
Ted Kremenek6db61092010-05-05 00:55:15 +00002454namespace {
2455class AnnotateTokensWorker {
2456 AnnotateTokensData &Annotated;
Ted Kremenek11949cb2010-05-05 00:55:17 +00002457 CXToken *Tokens;
2458 CXCursor *Cursors;
2459 unsigned NumTokens;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002460 unsigned TokIdx;
2461 CursorVisitor AnnotateVis;
2462 SourceManager &SrcMgr;
2463
2464 bool MoreTokens() const { return TokIdx < NumTokens; }
2465 unsigned NextToken() const { return TokIdx; }
2466 void AdvanceToken() { ++TokIdx; }
2467 SourceLocation GetTokenLoc(unsigned tokI) {
2468 return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]);
2469 }
2470
Ted Kremenek6db61092010-05-05 00:55:15 +00002471public:
Ted Kremenek11949cb2010-05-05 00:55:17 +00002472 AnnotateTokensWorker(AnnotateTokensData &annotated,
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002473 CXToken *tokens, CXCursor *cursors, unsigned numTokens,
2474 ASTUnit *CXXUnit, SourceRange RegionOfInterest)
Ted Kremenek11949cb2010-05-05 00:55:17 +00002475 : Annotated(annotated), Tokens(tokens), Cursors(cursors),
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002476 NumTokens(numTokens), TokIdx(0),
2477 AnnotateVis(CXXUnit, AnnotateTokensVisitor, this,
2478 Decl::MaxPCHLevel, RegionOfInterest),
2479 SrcMgr(CXXUnit->getSourceManager()) {}
Ted Kremenek11949cb2010-05-05 00:55:17 +00002480
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002481 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
Ted Kremenek6db61092010-05-05 00:55:15 +00002482 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002483 void AnnotateTokens(CXCursor parent);
Ted Kremenek6db61092010-05-05 00:55:15 +00002484};
2485}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002486
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002487void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) {
2488 // Walk the AST within the region of interest, annotating tokens
2489 // along the way.
2490 VisitChildren(parent);
Ted Kremenek11949cb2010-05-05 00:55:17 +00002491
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002492 for (unsigned I = 0 ; I < TokIdx ; ++I) {
2493 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
2494 if (Pos != Annotated.end())
2495 Cursors[I] = Pos->second;
2496 }
2497
2498 // Finish up annotating any tokens left.
2499 if (!MoreTokens())
2500 return;
2501
2502 const CXCursor &C = clang_getNullCursor();
2503 for (unsigned I = TokIdx ; I < NumTokens ; ++I) {
2504 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
2505 Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second;
Ted Kremenek11949cb2010-05-05 00:55:17 +00002506 }
2507}
2508
Ted Kremenek6db61092010-05-05 00:55:15 +00002509enum CXChildVisitResult
2510AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002511 CXSourceLocation Loc = clang_getCursorLocation(cursor);
2512 // We can always annotate a preprocessing directive/macro instantiation.
2513 if (clang_isPreprocessing(cursor.kind)) {
2514 Annotated[Loc.int_data] = cursor;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002515 return CXChildVisit_Recurse;
2516 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002517
2518 CXSourceRange cursorExtent = clang_getCursorExtent(cursor);
2519 SourceRange cursorRange = cxloc::translateCXSourceRange(cursorExtent);
Ted Kremeneka333c662010-05-12 05:29:33 +00002520
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002521 if (cursorRange.isInvalid())
2522 return CXChildVisit_Continue;
Ted Kremeneka333c662010-05-12 05:29:33 +00002523
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002524 SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data);
2525
Ted Kremeneka333c662010-05-12 05:29:33 +00002526 // Adjust the annotated range based specific declarations.
2527 const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
2528 if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) {
Ted Kremenek23173d72010-05-18 21:09:07 +00002529 Decl *D = cxcursor::getCursorDecl(cursor);
2530 // Don't visit synthesized ObjC methods, since they have no syntatic
2531 // representation in the source.
2532 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
2533 if (MD->isSynthesized())
2534 return CXChildVisit_Continue;
2535 }
2536 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
Ted Kremeneka333c662010-05-12 05:29:33 +00002537 if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
2538 TypeLoc TL = TI->getTypeLoc();
Abramo Bagnarabd054db2010-05-20 10:00:11 +00002539 SourceLocation TLoc = TL.getSourceRange().getBegin();
Ted Kremenek6bfd5332010-05-13 15:38:38 +00002540 if (TLoc.isValid() &&
2541 SrcMgr.isBeforeInTranslationUnit(TLoc, L))
Ted Kremeneka333c662010-05-12 05:29:33 +00002542 cursorRange.setBegin(TLoc);
Ted Kremeneka333c662010-05-12 05:29:33 +00002543 }
2544 }
2545 }
2546
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002547 const enum CXCursorKind K = clang_getCursorKind(parent);
2548 const CXCursor updateC =
2549 (clang_isInvalid(K) || K == CXCursor_TranslationUnit ||
2550 L.isMacroID())
2551 ? clang_getNullCursor() : parent;
2552
2553 while (MoreTokens()) {
2554 const unsigned I = NextToken();
2555 SourceLocation TokLoc = GetTokenLoc(I);
2556 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
2557 case RangeBefore:
2558 Cursors[I] = updateC;
2559 AdvanceToken();
2560 continue;
2561 case RangeAfter:
2562 return CXChildVisit_Continue;
2563 case RangeOverlap:
2564 break;
2565 }
2566 break;
2567 }
2568
2569 // Visit children to get their cursor information.
2570 const unsigned BeforeChildren = NextToken();
2571 VisitChildren(cursor);
2572 const unsigned AfterChildren = NextToken();
2573
2574 // Adjust 'Last' to the last token within the extent of the cursor.
2575 while (MoreTokens()) {
2576 const unsigned I = NextToken();
2577 SourceLocation TokLoc = GetTokenLoc(I);
2578 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
2579 case RangeBefore:
2580 assert(0 && "Infeasible");
2581 case RangeAfter:
2582 break;
2583 case RangeOverlap:
2584 Cursors[I] = updateC;
2585 AdvanceToken();
2586 continue;
2587 }
2588 break;
2589 }
2590 const unsigned Last = NextToken();
Ted Kremenek6db61092010-05-05 00:55:15 +00002591
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002592 // Scan the tokens that are at the beginning of the cursor, but are not
2593 // capture by the child cursors.
2594
2595 // For AST elements within macros, rely on a post-annotate pass to
2596 // to correctly annotate the tokens with cursors. Otherwise we can
2597 // get confusing results of having tokens that map to cursors that really
2598 // are expanded by an instantiation.
2599 if (L.isMacroID())
2600 cursor = clang_getNullCursor();
2601
2602 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
2603 if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
2604 break;
2605 Cursors[I] = cursor;
2606 }
2607 // Scan the tokens that are at the end of the cursor, but are not captured
2608 // but the child cursors.
2609 for (unsigned I = AfterChildren; I != Last; ++I)
2610 Cursors[I] = cursor;
2611
2612 TokIdx = Last;
2613 return CXChildVisit_Continue;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002614}
2615
Ted Kremenek6db61092010-05-05 00:55:15 +00002616static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
2617 CXCursor parent,
2618 CXClientData client_data) {
2619 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
2620}
2621
2622extern "C" {
2623
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002624void clang_annotateTokens(CXTranslationUnit TU,
2625 CXToken *Tokens, unsigned NumTokens,
2626 CXCursor *Cursors) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002627
2628 if (NumTokens == 0 || !Tokens || !Cursors)
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002629 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002630
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002631 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002632 if (!CXXUnit) {
2633 // Any token we don't specifically annotate will have a NULL cursor.
2634 const CXCursor &C = clang_getNullCursor();
2635 for (unsigned I = 0; I != NumTokens; ++I)
2636 Cursors[I] = C;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002637 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002638 }
2639
Douglas Gregorbdf60622010-03-05 21:16:25 +00002640 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002641
Douglas Gregor0396f462010-03-19 05:22:59 +00002642 // Determine the region of interest, which contains all of the tokens.
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002643 SourceRange RegionOfInterest;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002644 RegionOfInterest.setBegin(cxloc::translateSourceLocation(
2645 clang_getTokenLocation(TU, Tokens[0])));
2646
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002647 SourceLocation End
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002648 = cxloc::translateSourceLocation(clang_getTokenLocation(TU,
2649 Tokens[NumTokens - 1]));
Daniel Dunbard52864b2010-02-14 10:02:57 +00002650 RegionOfInterest.setEnd(CXXUnit->getPreprocessor().getLocForEndOfToken(End));
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002651
Douglas Gregor0396f462010-03-19 05:22:59 +00002652 // A mapping from the source locations found when re-lexing or traversing the
2653 // region of interest to the corresponding cursors.
2654 AnnotateTokensData Annotated;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002655
2656 // Relex the tokens within the source range to look for preprocessing
Douglas Gregor0396f462010-03-19 05:22:59 +00002657 // directives.
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002658 SourceManager &SourceMgr = CXXUnit->getSourceManager();
2659 std::pair<FileID, unsigned> BeginLocInfo
2660 = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin());
2661 std::pair<FileID, unsigned> EndLocInfo
2662 = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd());
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002663
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002664 llvm::StringRef Buffer;
Douglas Gregor0396f462010-03-19 05:22:59 +00002665 bool Invalid = false;
2666 if (BeginLocInfo.first == EndLocInfo.first &&
2667 ((Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid)),true) &&
2668 !Invalid) {
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002669 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
2670 CXXUnit->getASTContext().getLangOptions(),
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002671 Buffer.begin(), Buffer.data() + BeginLocInfo.second,
Douglas Gregor4ae8f292010-03-18 17:52:52 +00002672 Buffer.end());
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002673 Lex.SetCommentRetentionState(true);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002674
2675 // Lex tokens in raw mode until we hit the end of the range, to avoid
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002676 // entering #includes or expanding macros.
Douglas Gregor48072312010-03-18 15:23:44 +00002677 while (true) {
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002678 Token Tok;
2679 Lex.LexFromRawLexer(Tok);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002680
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002681 reprocess:
2682 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
2683 // We have found a preprocessing directive. Gobble it up so that we
2684 // don't see it while preprocessing these tokens later, but keep track of
2685 // all of the token locations inside this preprocessing directive so that
2686 // we can annotate them appropriately.
2687 //
2688 // FIXME: Some simple tests here could identify macro definitions and
2689 // #undefs, to provide specific cursor kinds for those.
2690 std::vector<SourceLocation> Locations;
2691 do {
2692 Locations.push_back(Tok.getLocation());
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002693 Lex.LexFromRawLexer(Tok);
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002694 } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof));
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002695
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002696 using namespace cxcursor;
2697 CXCursor Cursor
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002698 = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(),
2699 Locations.back()),
Ted Kremenek6db61092010-05-05 00:55:15 +00002700 CXXUnit);
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002701 for (unsigned I = 0, N = Locations.size(); I != N; ++I) {
2702 Annotated[Locations[I].getRawEncoding()] = Cursor;
2703 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002704
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002705 if (Tok.isAtStartOfLine())
2706 goto reprocess;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002707
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002708 continue;
2709 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002710
Douglas Gregor48072312010-03-18 15:23:44 +00002711 if (Tok.is(tok::eof))
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002712 break;
2713 }
Douglas Gregor4ae8f292010-03-18 17:52:52 +00002714 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002715
Douglas Gregor0396f462010-03-19 05:22:59 +00002716 // Annotate all of the source locations in the region of interest that map to
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002717 // a specific cursor.
2718 AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens,
2719 CXXUnit, RegionOfInterest);
2720 W.AnnotateTokens(clang_getTranslationUnitCursor(CXXUnit));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002721}
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002722} // end: extern "C"
2723
2724//===----------------------------------------------------------------------===//
Ted Kremenek16b42592010-03-03 06:36:57 +00002725// Operations for querying linkage of a cursor.
2726//===----------------------------------------------------------------------===//
2727
2728extern "C" {
2729CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
Douglas Gregor0396f462010-03-19 05:22:59 +00002730 if (!clang_isDeclaration(cursor.kind))
2731 return CXLinkage_Invalid;
2732
Ted Kremenek16b42592010-03-03 06:36:57 +00002733 Decl *D = cxcursor::getCursorDecl(cursor);
2734 if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
2735 switch (ND->getLinkage()) {
2736 case NoLinkage: return CXLinkage_NoLinkage;
2737 case InternalLinkage: return CXLinkage_Internal;
2738 case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
2739 case ExternalLinkage: return CXLinkage_External;
2740 };
2741
2742 return CXLinkage_Invalid;
2743}
2744} // end: extern "C"
2745
2746//===----------------------------------------------------------------------===//
Ted Kremenek45e1dae2010-04-12 21:22:16 +00002747// Operations for querying language of a cursor.
2748//===----------------------------------------------------------------------===//
2749
2750static CXLanguageKind getDeclLanguage(const Decl *D) {
2751 switch (D->getKind()) {
2752 default:
2753 break;
2754 case Decl::ImplicitParam:
2755 case Decl::ObjCAtDefsField:
2756 case Decl::ObjCCategory:
2757 case Decl::ObjCCategoryImpl:
2758 case Decl::ObjCClass:
2759 case Decl::ObjCCompatibleAlias:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00002760 case Decl::ObjCForwardProtocol:
2761 case Decl::ObjCImplementation:
2762 case Decl::ObjCInterface:
2763 case Decl::ObjCIvar:
2764 case Decl::ObjCMethod:
2765 case Decl::ObjCProperty:
2766 case Decl::ObjCPropertyImpl:
2767 case Decl::ObjCProtocol:
2768 return CXLanguage_ObjC;
2769 case Decl::CXXConstructor:
2770 case Decl::CXXConversion:
2771 case Decl::CXXDestructor:
2772 case Decl::CXXMethod:
2773 case Decl::CXXRecord:
2774 case Decl::ClassTemplate:
2775 case Decl::ClassTemplatePartialSpecialization:
2776 case Decl::ClassTemplateSpecialization:
2777 case Decl::Friend:
2778 case Decl::FriendTemplate:
2779 case Decl::FunctionTemplate:
2780 case Decl::LinkageSpec:
2781 case Decl::Namespace:
2782 case Decl::NamespaceAlias:
2783 case Decl::NonTypeTemplateParm:
2784 case Decl::StaticAssert:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00002785 case Decl::TemplateTemplateParm:
2786 case Decl::TemplateTypeParm:
2787 case Decl::UnresolvedUsingTypename:
2788 case Decl::UnresolvedUsingValue:
2789 case Decl::Using:
2790 case Decl::UsingDirective:
2791 case Decl::UsingShadow:
2792 return CXLanguage_CPlusPlus;
2793 }
2794
2795 return CXLanguage_C;
2796}
2797
2798extern "C" {
2799CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
2800 if (clang_isDeclaration(cursor.kind))
2801 return getDeclLanguage(cxcursor::getCursorDecl(cursor));
2802
2803 return CXLanguage_Invalid;
2804}
2805} // end: extern "C"
2806
Ted Kremenek9ada39a2010-05-17 20:06:56 +00002807
2808//===----------------------------------------------------------------------===//
2809// C++ AST instrospection.
2810//===----------------------------------------------------------------------===//
2811
2812extern "C" {
2813unsigned clang_CXXMethod_isStatic(CXCursor C) {
2814 if (!clang_isDeclaration(C.kind))
2815 return 0;
2816 CXXMethodDecl *D = dyn_cast<CXXMethodDecl>(cxcursor::getCursorDecl(C));
2817 return (D && D->isStatic()) ? 1 : 0;
Ted Kremenek40b492a2010-05-17 20:12:45 +00002818}
Ted Kremenekb12903e2010-05-18 22:32:15 +00002819
Ted Kremenek9ada39a2010-05-17 20:06:56 +00002820} // end: extern "C"
2821
Ted Kremenek45e1dae2010-04-12 21:22:16 +00002822//===----------------------------------------------------------------------===//
Ted Kremenekfb480492010-01-13 21:46:36 +00002823// CXString Operations.
2824//===----------------------------------------------------------------------===//
2825
2826extern "C" {
2827const char *clang_getCString(CXString string) {
2828 return string.Spelling;
2829}
2830
2831void clang_disposeString(CXString string) {
2832 if (string.MustFreeString && string.Spelling)
2833 free((void*)string.Spelling);
2834}
Ted Kremenek04bb7162010-01-22 22:44:15 +00002835
Ted Kremenekfb480492010-01-13 21:46:36 +00002836} // end: extern "C"
Ted Kremenek04bb7162010-01-22 22:44:15 +00002837
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002838namespace clang { namespace cxstring {
2839CXString createCXString(const char *String, bool DupString){
2840 CXString Str;
2841 if (DupString) {
2842 Str.Spelling = strdup(String);
2843 Str.MustFreeString = 1;
2844 } else {
2845 Str.Spelling = String;
2846 Str.MustFreeString = 0;
2847 }
2848 return Str;
2849}
2850
2851CXString createCXString(llvm::StringRef String, bool DupString) {
2852 CXString Result;
2853 if (DupString || (!String.empty() && String.data()[String.size()] != 0)) {
2854 char *Spelling = (char *)malloc(String.size() + 1);
2855 memmove(Spelling, String.data(), String.size());
2856 Spelling[String.size()] = 0;
2857 Result.Spelling = Spelling;
2858 Result.MustFreeString = 1;
2859 } else {
2860 Result.Spelling = String.data();
2861 Result.MustFreeString = 0;
2862 }
2863 return Result;
2864}
2865}}
2866
Ted Kremenek04bb7162010-01-22 22:44:15 +00002867//===----------------------------------------------------------------------===//
2868// Misc. utility functions.
2869//===----------------------------------------------------------------------===//
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002870
Ted Kremenek04bb7162010-01-22 22:44:15 +00002871extern "C" {
2872
Ted Kremeneka2a9d6e2010-02-12 22:54:40 +00002873CXString clang_getClangVersion() {
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002874 return createCXString(getClangFullVersion());
Ted Kremenek04bb7162010-01-22 22:44:15 +00002875}
2876
2877} // end: extern "C"