blob: 6414166d37238b147e9c2ff3bd2c50b76fb0d3fa [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?");
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000146 if (R1.getEnd() != R2.getBegin() &&
Daniel Dunbard52864b2010-02-14 10:02:57 +0000147 SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000148 return RangeBefore;
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000149 if (R2.getEnd() != R1.getBegin() &&
Daniel Dunbard52864b2010-02-14 10:02:57 +0000150 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?");
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000161 if (L == R.getBegin() || L == R.getEnd())
Ted Kremenekfbd84ca2010-05-05 00:55:23 +0000162 return RangeOverlap;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +0000163 if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
164 return RangeBefore;
165 if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
166 return RangeAfter;
167 return RangeOverlap;
168}
169
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000170/// \brief Translate a Clang source range into a CIndex source range.
171///
172/// Clang internally represents ranges where the end location points to the
173/// start of the token at the end. However, for external clients it is more
174/// useful to have a CXSourceRange be a proper half-open interval. This routine
175/// does the appropriate translation.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000176CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000177 const LangOptions &LangOpts,
Chris Lattner0a76aae2010-06-18 22:45:06 +0000178 const CharSourceRange &R) {
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000179 // We want the last character in this location, so we will adjust the
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000180 // location accordingly.
181 // FIXME: How do do this with a macro instantiation location?
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000182 SourceLocation EndLoc = R.getEnd();
Chris Lattner0a76aae2010-06-18 22:45:06 +0000183 if (R.isTokenRange() && !EndLoc.isInvalid() && EndLoc.isFileID()) {
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000184 unsigned Length = Lexer::MeasureTokenLength(EndLoc, SM, LangOpts);
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000185 EndLoc = EndLoc.getFileLocWithOffset(Length);
186 }
187
188 CXSourceRange Result = { { (void *)&SM, (void *)&LangOpts },
189 R.getBegin().getRawEncoding(),
190 EndLoc.getRawEncoding() };
191 return Result;
192}
Douglas Gregor1db19de2010-01-19 21:36:55 +0000193
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000194//===----------------------------------------------------------------------===//
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000195// Cursor visitor.
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000196//===----------------------------------------------------------------------===//
197
Steve Naroff89922f82009-08-31 00:59:03 +0000198namespace {
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000199
Douglas Gregorb1373d02010-01-20 20:59:29 +0000200// Cursor visitor.
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000201class CursorVisitor : public DeclVisitor<CursorVisitor, bool>,
Douglas Gregora59e3902010-01-21 23:27:09 +0000202 public TypeLocVisitor<CursorVisitor, bool>,
203 public StmtVisitor<CursorVisitor, bool>
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000204{
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000205 /// \brief The translation unit we are traversing.
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000206 ASTUnit *TU;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000207
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000208 /// \brief The parent cursor whose children we are traversing.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000209 CXCursor Parent;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000210
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000211 /// \brief The declaration that serves at the parent of any statement or
212 /// expression nodes.
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000213 Decl *StmtParent;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000214
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000215 /// \brief The visitor function.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000216 CXCursorVisitor Visitor;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000217
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000218 /// \brief The opaque client data, to be passed along to the visitor.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000219 CXClientData ClientData;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000220
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000221 // MaxPCHLevel - the maximum PCH level of declarations that we will pass on
222 // to the visitor. Declarations with a PCH level greater than this value will
223 // be suppressed.
224 unsigned MaxPCHLevel;
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000225
226 /// \brief When valid, a source range to which the cursor should restrict
227 /// its search.
228 SourceRange RegionOfInterest;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000229
Douglas Gregorb1373d02010-01-20 20:59:29 +0000230 using DeclVisitor<CursorVisitor, bool>::Visit;
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000231 using TypeLocVisitor<CursorVisitor, bool>::Visit;
Douglas Gregora59e3902010-01-21 23:27:09 +0000232 using StmtVisitor<CursorVisitor, bool>::Visit;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000233
234 /// \brief Determine whether this particular source range comes before, comes
235 /// after, or overlaps the region of interest.
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000236 ///
Daniel Dunbard52864b2010-02-14 10:02:57 +0000237 /// \param R a half-open source range retrieved from the abstract syntax tree.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000238 RangeComparisonResult CompareRegionOfInterest(SourceRange R);
239
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000240 class SetParentRAII {
241 CXCursor &Parent;
242 Decl *&StmtParent;
243 CXCursor OldParent;
244
245 public:
246 SetParentRAII(CXCursor &Parent, Decl *&StmtParent, CXCursor NewParent)
247 : Parent(Parent), StmtParent(StmtParent), OldParent(Parent)
248 {
249 Parent = NewParent;
250 if (clang_isDeclaration(Parent.kind))
251 StmtParent = getCursorDecl(Parent);
252 }
253
254 ~SetParentRAII() {
255 Parent = OldParent;
256 if (clang_isDeclaration(Parent.kind))
257 StmtParent = getCursorDecl(Parent);
258 }
259 };
260
Steve Naroff89922f82009-08-31 00:59:03 +0000261public:
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000262 CursorVisitor(ASTUnit *TU, CXCursorVisitor Visitor, CXClientData ClientData,
263 unsigned MaxPCHLevel,
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000264 SourceRange RegionOfInterest = SourceRange())
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000265 : TU(TU), Visitor(Visitor), ClientData(ClientData),
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000266 MaxPCHLevel(MaxPCHLevel), RegionOfInterest(RegionOfInterest)
Douglas Gregorb1373d02010-01-20 20:59:29 +0000267 {
268 Parent.kind = CXCursor_NoDeclFound;
269 Parent.data[0] = 0;
270 Parent.data[1] = 0;
271 Parent.data[2] = 0;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000272 StmtParent = 0;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000273 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000274
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000275 bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false);
Douglas Gregor788f5a12010-03-20 00:41:21 +0000276
277 std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
278 getPreprocessedEntities();
279
Douglas Gregorb1373d02010-01-20 20:59:29 +0000280 bool VisitChildren(CXCursor Parent);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000281
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000282 // Declaration visitors
Ted Kremenek09dfa372010-02-18 05:46:33 +0000283 bool VisitAttributes(Decl *D);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000284 bool VisitBlockDecl(BlockDecl *B);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000285 bool VisitDeclContext(DeclContext *DC);
Ted Kremenek4540c9c2010-02-18 18:47:08 +0000286 bool VisitTranslationUnitDecl(TranslationUnitDecl *D);
287 bool VisitTypedefDecl(TypedefDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000288 bool VisitTagDecl(TagDecl *D);
289 bool VisitEnumConstantDecl(EnumConstantDecl *D);
290 bool VisitDeclaratorDecl(DeclaratorDecl *DD);
291 bool VisitFunctionDecl(FunctionDecl *ND);
292 bool VisitFieldDecl(FieldDecl *D);
Ted Kremenek4540c9c2010-02-18 18:47:08 +0000293 bool VisitVarDecl(VarDecl *);
Ted Kremenek79758f62010-02-18 22:36:18 +0000294 bool VisitObjCMethodDecl(ObjCMethodDecl *ND);
295 bool VisitObjCContainerDecl(ObjCContainerDecl *D);
296 bool VisitObjCCategoryDecl(ObjCCategoryDecl *ND);
297 bool VisitObjCProtocolDecl(ObjCProtocolDecl *PID);
Ted Kremenek23173d72010-05-18 21:09:07 +0000298 bool VisitObjCPropertyDecl(ObjCPropertyDecl *PD);
Ted Kremenek79758f62010-02-18 22:36:18 +0000299 bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
300 bool VisitObjCImplDecl(ObjCImplDecl *D);
301 bool VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
302 bool VisitObjCImplementationDecl(ObjCImplementationDecl *D);
303 // FIXME: ObjCPropertyDecl requires TypeSourceInfo, getter/setter locations,
304 // etc.
305 // FIXME: ObjCCompatibleAliasDecl requires aliased-class locations.
306 bool VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D);
307 bool VisitObjCClassDecl(ObjCClassDecl *D);
Ted Kremeneka0536d82010-05-07 01:04:29 +0000308 bool VisitLinkageSpecDecl(LinkageSpecDecl *D);
Ted Kremenek8f06e0e2010-05-06 23:38:21 +0000309 bool VisitNamespaceDecl(NamespaceDecl *D);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000310
311 // Type visitors
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000312 // FIXME: QualifiedTypeLoc doesn't provide any location information
313 bool VisitBuiltinTypeLoc(BuiltinTypeLoc TL);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000314 bool VisitTypedefTypeLoc(TypedefTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000315 bool VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL);
316 bool VisitTagTypeLoc(TagTypeLoc TL);
317 // FIXME: TemplateTypeParmTypeLoc doesn't provide any location information
318 bool VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL);
John McCallc12c5bb2010-05-15 11:32:37 +0000319 bool VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000320 bool VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL);
321 bool VisitPointerTypeLoc(PointerTypeLoc TL);
322 bool VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL);
323 bool VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL);
324 bool VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL);
325 bool VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL);
326 bool VisitFunctionTypeLoc(FunctionTypeLoc TL);
327 bool VisitArrayTypeLoc(ArrayTypeLoc TL);
Douglas Gregor2332c112010-01-21 20:48:56 +0000328 // FIXME: Implement for TemplateSpecializationTypeLoc
329 // FIXME: Implement visitors here when the unimplemented TypeLocs get
330 // implemented
331 bool VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL);
332 bool VisitTypeOfTypeLoc(TypeOfTypeLoc TL);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000333
Douglas Gregora59e3902010-01-21 23:27:09 +0000334 // Statement visitors
335 bool VisitStmt(Stmt *S);
336 bool VisitDeclStmt(DeclStmt *S);
Douglas Gregorf5bab412010-01-22 01:00:11 +0000337 // FIXME: LabelStmt label?
338 bool VisitIfStmt(IfStmt *S);
339 bool VisitSwitchStmt(SwitchStmt *S);
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000340 bool VisitCaseStmt(CaseStmt *S);
Douglas Gregor263b47b2010-01-25 16:12:32 +0000341 bool VisitWhileStmt(WhileStmt *S);
342 bool VisitForStmt(ForStmt *S);
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000343// bool VisitSwitchCase(SwitchCase *S);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000344
Douglas Gregor336fd812010-01-23 00:40:08 +0000345 // Expression visitors
Douglas Gregor6cd24e22010-07-29 00:26:18 +0000346 bool VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000347 bool VisitBlockExpr(BlockExpr *B);
Douglas Gregor336fd812010-01-23 00:40:08 +0000348 bool VisitCompoundLiteralExpr(CompoundLiteralExpr *E);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000349 bool VisitExplicitCastExpr(ExplicitCastExpr *E);
Douglas Gregorc2350e52010-03-08 16:40:19 +0000350 bool VisitObjCMessageExpr(ObjCMessageExpr *E);
Douglas Gregor81d34662010-04-20 15:39:42 +0000351 bool VisitObjCEncodeExpr(ObjCEncodeExpr *E);
Douglas Gregor8ecdb652010-04-28 22:16:22 +0000352 bool VisitOffsetOfExpr(OffsetOfExpr *E);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000353 bool VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E);
Steve Naroff89922f82009-08-31 00:59:03 +0000354};
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000355
Ted Kremenekab188932010-01-05 19:32:54 +0000356} // end anonymous namespace
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000357
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000358static SourceRange getRawCursorExtent(CXCursor C);
359
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000360RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000361 return RangeCompare(TU->getSourceManager(), R, RegionOfInterest);
362}
363
Douglas Gregorb1373d02010-01-20 20:59:29 +0000364/// \brief Visit the given cursor and, if requested by the visitor,
365/// its children.
366///
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000367/// \param Cursor the cursor to visit.
368///
369/// \param CheckRegionOfInterest if true, then the caller already checked that
370/// this cursor is within the region of interest.
371///
Douglas Gregorb1373d02010-01-20 20:59:29 +0000372/// \returns true if the visitation should be aborted, false if it
373/// should continue.
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000374bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
Douglas Gregorb1373d02010-01-20 20:59:29 +0000375 if (clang_isInvalid(Cursor.kind))
376 return false;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000377
Douglas Gregorb1373d02010-01-20 20:59:29 +0000378 if (clang_isDeclaration(Cursor.kind)) {
379 Decl *D = getCursorDecl(Cursor);
380 assert(D && "Invalid declaration cursor");
381 if (D->getPCHLevel() > MaxPCHLevel)
382 return false;
383
384 if (D->isImplicit())
385 return false;
386 }
387
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000388 // If we have a range of interest, and this cursor doesn't intersect with it,
389 // we're done.
390 if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000391 SourceRange Range = getRawCursorExtent(Cursor);
Daniel Dunbarf408f322010-02-14 08:32:05 +0000392 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 Gregoreb8837b2010-08-03 19:06:41 +0000481 for (ASTUnit::top_level_iterator TL = CXXUnit->top_level_begin(),
482 TLEnd = CXXUnit->top_level_end();
483 TL != TLEnd; ++TL) {
484 if (Visit(MakeCXCursor(*TL, 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
Ted Kremenek664cffd2010-07-22 11:30:19 +0000523 if (Stmt *Body = B->getBody())
524 return Visit(MakeCXCursor(Body, StmtParent, TU));
525
526 return false;
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000527}
528
Douglas Gregorb1373d02010-01-20 20:59:29 +0000529bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000530 for (DeclContext::decl_iterator
Douglas Gregorb1373d02010-01-20 20:59:29 +0000531 I = DC->decls_begin(), E = DC->decls_end(); I != E; ++I) {
Ted Kremenek09dfa372010-02-18 05:46:33 +0000532
Ted Kremenek23173d72010-05-18 21:09:07 +0000533 Decl *D = *I;
534 if (D->getLexicalDeclContext() != DC)
535 continue;
536
537 CXCursor Cursor = MakeCXCursor(D, TU);
Daniel Dunbard52864b2010-02-14 10:02:57 +0000538
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000539 if (RegionOfInterest.isValid()) {
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000540 SourceRange Range = getRawCursorExtent(Cursor);
Daniel Dunbard52864b2010-02-14 10:02:57 +0000541 if (Range.isInvalid())
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000542 continue;
Daniel Dunbard52864b2010-02-14 10:02:57 +0000543
544 switch (CompareRegionOfInterest(Range)) {
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000545 case RangeBefore:
546 // This declaration comes before the region of interest; skip it.
547 continue;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000548
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000549 case RangeAfter:
550 // This declaration comes after the region of interest; we're done.
551 return false;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000552
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000553 case RangeOverlap:
554 // This declaration overlaps the region of interest; visit it.
555 break;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000556 }
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000557 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000558
Daniel Dunbard52864b2010-02-14 10:02:57 +0000559 if (Visit(Cursor, true))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000560 return true;
561 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000562
Douglas Gregorb1373d02010-01-20 20:59:29 +0000563 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000564}
565
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000566bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
567 llvm_unreachable("Translation units are visited directly by Visit()");
568 return false;
569}
570
571bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
572 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
573 return Visit(TSInfo->getTypeLoc());
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000574
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000575 return false;
576}
577
578bool CursorVisitor::VisitTagDecl(TagDecl *D) {
579 return VisitDeclContext(D);
580}
581
582bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
583 if (Expr *Init = D->getInitExpr())
584 return Visit(MakeCXCursor(Init, StmtParent, TU));
585 return false;
586}
587
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000588bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
589 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
590 if (Visit(TSInfo->getTypeLoc()))
591 return true;
592
593 return false;
594}
595
Douglas Gregorb1373d02010-01-20 20:59:29 +0000596bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000597 if (VisitDeclaratorDecl(ND))
598 return true;
599
Douglas Gregora59e3902010-01-21 23:27:09 +0000600 if (ND->isThisDeclarationADefinition() &&
601 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
602 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000603
Douglas Gregorb1373d02010-01-20 20:59:29 +0000604 return false;
605}
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000606
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000607bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
608 if (VisitDeclaratorDecl(D))
609 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000610
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000611 if (Expr *BitWidth = D->getBitWidth())
612 return Visit(MakeCXCursor(BitWidth, StmtParent, TU));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000613
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000614 return false;
615}
616
617bool CursorVisitor::VisitVarDecl(VarDecl *D) {
618 if (VisitDeclaratorDecl(D))
619 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000620
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000621 if (Expr *Init = D->getInit())
622 return Visit(MakeCXCursor(Init, StmtParent, TU));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000623
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000624 return false;
625}
626
627bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
Douglas Gregor4bc1cb62010-03-08 14:59:44 +0000628 if (TypeSourceInfo *TSInfo = ND->getResultTypeSourceInfo())
629 if (Visit(TSInfo->getTypeLoc()))
630 return true;
631
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000632 for (ObjCMethodDecl::param_iterator P = ND->param_begin(),
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000633 PEnd = ND->param_end();
634 P != PEnd; ++P) {
635 if (Visit(MakeCXCursor(*P, TU)))
636 return true;
637 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000638
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000639 if (ND->isThisDeclarationADefinition() &&
640 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
641 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000642
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000643 return false;
644}
645
Douglas Gregora59e3902010-01-21 23:27:09 +0000646bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
647 return VisitDeclContext(D);
648}
649
Douglas Gregorb1373d02010-01-20 20:59:29 +0000650bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000651 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
652 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000653 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000654
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000655 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
656 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
657 E = ND->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000658 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000659 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000660
Douglas Gregora59e3902010-01-21 23:27:09 +0000661 return VisitObjCContainerDecl(ND);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000662}
663
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000664bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
665 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
666 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
667 E = PID->protocol_end(); I != E; ++I, ++PL)
668 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
669 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000670
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000671 return VisitObjCContainerDecl(PID);
672}
673
Ted Kremenek23173d72010-05-18 21:09:07 +0000674bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
John McCallfc929202010-06-04 22:33:30 +0000675 if (Visit(PD->getTypeSourceInfo()->getTypeLoc()))
676 return true;
677
Ted Kremenek23173d72010-05-18 21:09:07 +0000678 // FIXME: This implements a workaround with @property declarations also being
679 // installed in the DeclContext for the @interface. Eventually this code
680 // should be removed.
681 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
682 if (!CDecl || !CDecl->IsClassExtension())
683 return false;
684
685 ObjCInterfaceDecl *ID = CDecl->getClassInterface();
686 if (!ID)
687 return false;
688
689 IdentifierInfo *PropertyId = PD->getIdentifier();
690 ObjCPropertyDecl *prevDecl =
691 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId);
692
693 if (!prevDecl)
694 return false;
695
696 // Visit synthesized methods since they will be skipped when visiting
697 // the @interface.
698 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
699 if (MD->isSynthesized())
700 if (Visit(MakeCXCursor(MD, TU)))
701 return true;
702
703 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
704 if (MD->isSynthesized())
705 if (Visit(MakeCXCursor(MD, TU)))
706 return true;
707
708 return false;
709}
710
Douglas Gregorb1373d02010-01-20 20:59:29 +0000711bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000712 // Issue callbacks for super class.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000713 if (D->getSuperClass() &&
714 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000715 D->getSuperClassLoc(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000716 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000717 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000718
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000719 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
720 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
721 E = D->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000722 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000723 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000724
Douglas Gregora59e3902010-01-21 23:27:09 +0000725 return VisitObjCContainerDecl(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000726}
727
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000728bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
729 return VisitObjCContainerDecl(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000730}
731
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000732bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
Ted Kremenekebfa3392010-03-19 20:39:03 +0000733 // 'ID' could be null when dealing with invalid code.
734 if (ObjCInterfaceDecl *ID = D->getClassInterface())
735 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
736 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000737
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000738 return VisitObjCImplDecl(D);
739}
740
741bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
742#if 0
743 // Issue callbacks for super class.
744 // FIXME: No source location information!
745 if (D->getSuperClass() &&
746 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000747 D->getSuperClassLoc(),
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000748 TU)))
749 return true;
750#endif
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000751
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000752 return VisitObjCImplDecl(D);
753}
754
755bool CursorVisitor::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
756 ObjCForwardProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
757 for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(),
758 E = D->protocol_end();
759 I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000760 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000761 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000762
763 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000764}
765
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000766bool CursorVisitor::VisitObjCClassDecl(ObjCClassDecl *D) {
767 for (ObjCClassDecl::iterator C = D->begin(), CEnd = D->end(); C != CEnd; ++C)
768 if (Visit(MakeCursorObjCClassRef(C->getInterface(), C->getLocation(), TU)))
769 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000770
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000771 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000772}
773
Ted Kremenek8f06e0e2010-05-06 23:38:21 +0000774bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
775 return VisitDeclContext(D);
776}
777
Ted Kremeneka0536d82010-05-07 01:04:29 +0000778bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
779 return VisitDeclContext(D);
780}
781
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000782bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
783 ASTContext &Context = TU->getASTContext();
784
785 // Some builtin types (such as Objective-C's "id", "sel", and
786 // "Class") have associated declarations. Create cursors for those.
787 QualType VisitType;
788 switch (TL.getType()->getAs<BuiltinType>()->getKind()) {
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000789 case BuiltinType::Void:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000790 case BuiltinType::Bool:
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000791 case BuiltinType::Char_U:
792 case BuiltinType::UChar:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000793 case BuiltinType::Char16:
794 case BuiltinType::Char32:
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000795 case BuiltinType::UShort:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000796 case BuiltinType::UInt:
797 case BuiltinType::ULong:
798 case BuiltinType::ULongLong:
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000799 case BuiltinType::UInt128:
800 case BuiltinType::Char_S:
801 case BuiltinType::SChar:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000802 case BuiltinType::WChar:
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000803 case BuiltinType::Short:
804 case BuiltinType::Int:
805 case BuiltinType::Long:
806 case BuiltinType::LongLong:
807 case BuiltinType::Int128:
808 case BuiltinType::Float:
809 case BuiltinType::Double:
810 case BuiltinType::LongDouble:
811 case BuiltinType::NullPtr:
812 case BuiltinType::Overload:
813 case BuiltinType::Dependent:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000814 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000815
816 case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor?
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000817 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000818
Ted Kremenekc4174cc2010-02-18 18:52:18 +0000819 case BuiltinType::ObjCId:
820 VisitType = Context.getObjCIdType();
821 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +0000822
823 case BuiltinType::ObjCClass:
824 VisitType = Context.getObjCClassType();
825 break;
826
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000827 case BuiltinType::ObjCSel:
828 VisitType = Context.getObjCSelType();
829 break;
830 }
831
832 if (!VisitType.isNull()) {
833 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000834 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000835 TU));
836 }
837
838 return false;
839}
840
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000841bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
842 return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU));
843}
844
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000845bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
846 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
847}
848
849bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
850 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
851}
852
853bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
854 if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU)))
855 return true;
856
John McCallc12c5bb2010-05-15 11:32:37 +0000857 return false;
858}
859
860bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
861 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
862 return true;
863
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000864 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
865 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
866 TU)))
867 return true;
868 }
869
870 return false;
871}
872
873bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
John McCallc12c5bb2010-05-15 11:32:37 +0000874 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000875}
876
877bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
878 return Visit(TL.getPointeeLoc());
879}
880
881bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
882 return Visit(TL.getPointeeLoc());
883}
884
885bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
886 return Visit(TL.getPointeeLoc());
887}
888
889bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000890 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000891}
892
893bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000894 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000895}
896
897bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
898 if (Visit(TL.getResultLoc()))
899 return true;
900
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000901 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
Ted Kremenek5dbacb42010-04-07 00:27:13 +0000902 if (Decl *D = TL.getArg(I))
903 if (Visit(MakeCXCursor(D, TU)))
904 return true;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000905
906 return false;
907}
908
909bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
910 if (Visit(TL.getElementLoc()))
911 return true;
912
913 if (Expr *Size = TL.getSizeExpr())
914 return Visit(MakeCXCursor(Size, StmtParent, TU));
915
916 return false;
917}
918
Douglas Gregor2332c112010-01-21 20:48:56 +0000919bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
920 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
921}
922
923bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
924 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
925 return Visit(TSInfo->getTypeLoc());
926
927 return false;
928}
929
Douglas Gregora59e3902010-01-21 23:27:09 +0000930bool CursorVisitor::VisitStmt(Stmt *S) {
931 for (Stmt::child_iterator Child = S->child_begin(), ChildEnd = S->child_end();
932 Child != ChildEnd; ++Child) {
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000933 if (Stmt *C = *Child)
934 if (Visit(MakeCXCursor(C, StmtParent, TU)))
935 return true;
Douglas Gregora59e3902010-01-21 23:27:09 +0000936 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000937
Douglas Gregora59e3902010-01-21 23:27:09 +0000938 return false;
939}
940
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000941bool CursorVisitor::VisitCaseStmt(CaseStmt *S) {
942 // Specially handle CaseStmts because they can be nested, e.g.:
943 //
944 // case 1:
945 // case 2:
946 //
947 // In this case the second CaseStmt is the child of the first. Walking
948 // these recursively can blow out the stack.
949 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU);
950 while (true) {
951 // Set the Parent field to Cursor, then back to its old value once we're
952 // done.
953 SetParentRAII SetParent(Parent, StmtParent, Cursor);
954
955 if (Stmt *LHS = S->getLHS())
956 if (Visit(MakeCXCursor(LHS, StmtParent, TU)))
957 return true;
958 if (Stmt *RHS = S->getRHS())
959 if (Visit(MakeCXCursor(RHS, StmtParent, TU)))
960 return true;
961 if (Stmt *SubStmt = S->getSubStmt()) {
962 if (!isa<CaseStmt>(SubStmt))
963 return Visit(MakeCXCursor(SubStmt, StmtParent, TU));
964
965 // Specially handle 'CaseStmt' so that we don't blow out the stack.
966 CaseStmt *CS = cast<CaseStmt>(SubStmt);
967 Cursor = MakeCXCursor(CS, StmtParent, TU);
968 if (RegionOfInterest.isValid()) {
969 SourceRange Range = CS->getSourceRange();
970 if (Range.isInvalid() || CompareRegionOfInterest(Range))
971 return false;
972 }
973
974 switch (Visitor(Cursor, Parent, ClientData)) {
975 case CXChildVisit_Break: return true;
976 case CXChildVisit_Continue: return false;
977 case CXChildVisit_Recurse:
978 // Perform tail-recursion manually.
979 S = CS;
980 continue;
981 }
982 }
983 return false;
984 }
985}
986
Douglas Gregora59e3902010-01-21 23:27:09 +0000987bool CursorVisitor::VisitDeclStmt(DeclStmt *S) {
988 for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end();
989 D != DEnd; ++D) {
Douglas Gregor263b47b2010-01-25 16:12:32 +0000990 if (*D && Visit(MakeCXCursor(*D, TU)))
Douglas Gregora59e3902010-01-21 23:27:09 +0000991 return true;
992 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000993
Douglas Gregora59e3902010-01-21 23:27:09 +0000994 return false;
995}
996
Douglas Gregorf5bab412010-01-22 01:00:11 +0000997bool CursorVisitor::VisitIfStmt(IfStmt *S) {
998 if (VarDecl *Var = S->getConditionVariable()) {
999 if (Visit(MakeCXCursor(Var, TU)))
1000 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001001 }
1002
Douglas Gregor263b47b2010-01-25 16:12:32 +00001003 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1004 return true;
Douglas Gregorf5bab412010-01-22 01:00:11 +00001005 if (S->getThen() && Visit(MakeCXCursor(S->getThen(), StmtParent, TU)))
1006 return true;
Douglas Gregorf5bab412010-01-22 01:00:11 +00001007 if (S->getElse() && Visit(MakeCXCursor(S->getElse(), StmtParent, TU)))
1008 return true;
1009
1010 return false;
1011}
1012
1013bool CursorVisitor::VisitSwitchStmt(SwitchStmt *S) {
1014 if (VarDecl *Var = S->getConditionVariable()) {
1015 if (Visit(MakeCXCursor(Var, TU)))
1016 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001017 }
1018
Douglas Gregor263b47b2010-01-25 16:12:32 +00001019 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1020 return true;
1021 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1022 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001023
Douglas Gregor263b47b2010-01-25 16:12:32 +00001024 return false;
1025}
1026
1027bool CursorVisitor::VisitWhileStmt(WhileStmt *S) {
1028 if (VarDecl *Var = S->getConditionVariable()) {
1029 if (Visit(MakeCXCursor(Var, TU)))
1030 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001031 }
1032
Douglas Gregor263b47b2010-01-25 16:12:32 +00001033 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1034 return true;
1035 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
Douglas Gregorf5bab412010-01-22 01:00:11 +00001036 return true;
1037
Douglas Gregor263b47b2010-01-25 16:12:32 +00001038 return false;
1039}
1040
1041bool CursorVisitor::VisitForStmt(ForStmt *S) {
1042 if (S->getInit() && Visit(MakeCXCursor(S->getInit(), StmtParent, TU)))
1043 return true;
1044 if (VarDecl *Var = S->getConditionVariable()) {
1045 if (Visit(MakeCXCursor(Var, TU)))
1046 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001047 }
1048
Douglas Gregor263b47b2010-01-25 16:12:32 +00001049 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1050 return true;
1051 if (S->getInc() && Visit(MakeCXCursor(S->getInc(), StmtParent, TU)))
1052 return true;
Douglas Gregorf5bab412010-01-22 01:00:11 +00001053 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1054 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001055
Douglas Gregorf5bab412010-01-22 01:00:11 +00001056 return false;
1057}
1058
Douglas Gregor6cd24e22010-07-29 00:26:18 +00001059bool CursorVisitor::VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E) {
1060 if (Visit(MakeCXCursor(E->getArg(0), StmtParent, TU)))
1061 return true;
1062
1063 if (Visit(MakeCXCursor(E->getCallee(), StmtParent, TU)))
1064 return true;
1065
1066 for (unsigned I = 1, N = E->getNumArgs(); I != N; ++I)
1067 if (Visit(MakeCXCursor(E->getArg(I), StmtParent, TU)))
1068 return true;
1069
1070 return false;
1071}
1072
Ted Kremenek1ee6cad2010-04-11 21:47:37 +00001073bool CursorVisitor::VisitBlockExpr(BlockExpr *B) {
1074 return Visit(B->getBlockDecl());
1075}
1076
Douglas Gregor8ecdb652010-04-28 22:16:22 +00001077bool CursorVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) {
1078 // FIXME: Visit fields as well?
1079 if (Visit(E->getTypeSourceInfo()->getTypeLoc()))
1080 return true;
1081
1082 return VisitExpr(E);
1083}
1084
Douglas Gregor336fd812010-01-23 00:40:08 +00001085bool CursorVisitor::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E) {
1086 if (E->isArgumentType()) {
1087 if (TypeSourceInfo *TSInfo = E->getArgumentTypeInfo())
1088 return Visit(TSInfo->getTypeLoc());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001089
Douglas Gregor336fd812010-01-23 00:40:08 +00001090 return false;
1091 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001092
Douglas Gregor336fd812010-01-23 00:40:08 +00001093 return VisitExpr(E);
1094}
1095
1096bool CursorVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) {
1097 if (TypeSourceInfo *TSInfo = E->getTypeInfoAsWritten())
1098 if (Visit(TSInfo->getTypeLoc()))
1099 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001100
Douglas Gregor336fd812010-01-23 00:40:08 +00001101 return VisitCastExpr(E);
1102}
1103
1104bool CursorVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) {
1105 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1106 if (Visit(TSInfo->getTypeLoc()))
1107 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001108
Douglas Gregor336fd812010-01-23 00:40:08 +00001109 return VisitExpr(E);
1110}
1111
Douglas Gregorc2350e52010-03-08 16:40:19 +00001112bool CursorVisitor::VisitObjCMessageExpr(ObjCMessageExpr *E) {
Douglas Gregor04badcf2010-04-21 00:45:42 +00001113 if (TypeSourceInfo *TSInfo = E->getClassReceiverTypeInfo())
1114 if (Visit(TSInfo->getTypeLoc()))
1115 return true;
Douglas Gregorc2350e52010-03-08 16:40:19 +00001116
1117 return VisitExpr(E);
1118}
1119
Douglas Gregor81d34662010-04-20 15:39:42 +00001120bool CursorVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) {
1121 return Visit(E->getEncodedTypeSourceInfo()->getTypeLoc());
1122}
1123
1124
Ted Kremenek09dfa372010-02-18 05:46:33 +00001125bool CursorVisitor::VisitAttributes(Decl *D) {
1126 for (const Attr *A = D->getAttrs(); A; A = A->getNext())
1127 if (Visit(MakeCXCursor(A, D, TU)))
1128 return true;
1129
1130 return false;
1131}
1132
Benjamin Kramer5e4bc592009-10-18 16:11:04 +00001133extern "C" {
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001134CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
1135 int displayDiagnostics) {
Douglas Gregora030b7c2010-01-22 20:35:53 +00001136 CIndexer *CIdxr = new CIndexer();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00001137 if (excludeDeclarationsFromPCH)
1138 CIdxr->setOnlyLocalDecls();
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001139 if (displayDiagnostics)
1140 CIdxr->setDisplayDiagnostics();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00001141 return CIdxr;
Steve Naroff600866c2009-08-27 19:51:58 +00001142}
1143
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001144void clang_disposeIndex(CXIndex CIdx) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001145 if (CIdx)
1146 delete static_cast<CIndexer *>(CIdx);
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00001147}
1148
Daniel Dunbar8506dde2009-12-03 01:54:28 +00001149void clang_setUseExternalASTGeneration(CXIndex CIdx, int value) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001150 if (CIdx) {
1151 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
1152 CXXIdx->setUseExternalASTGeneration(value);
1153 }
Daniel Dunbar8506dde2009-12-03 01:54:28 +00001154}
1155
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001156CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
Douglas Gregora88084b2010-02-18 18:08:43 +00001157 const char *ast_filename) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001158 if (!CIdx)
1159 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001160
Douglas Gregor7d1d49d2009-10-16 20:01:17 +00001161 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001162
Douglas Gregor28019772010-04-05 23:52:57 +00001163 llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
1164 return ASTUnit::LoadFromPCHFile(ast_filename, Diags,
Douglas Gregora88084b2010-02-18 18:08:43 +00001165 CXXIdx->getOnlyLocalDecls(),
1166 0, 0, true);
Steve Naroff600866c2009-08-27 19:51:58 +00001167}
1168
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001169CXTranslationUnit
1170clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
1171 const char *source_filename,
1172 int num_command_line_args,
Douglas Gregor4db64a42010-01-23 00:14:00 +00001173 const char **command_line_args,
1174 unsigned num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +00001175 struct CXUnsavedFile *unsaved_files) {
Douglas Gregor5a430212010-07-21 18:52:53 +00001176 return clang_parseTranslationUnit(CIdx, source_filename,
1177 command_line_args, num_command_line_args,
1178 unsaved_files, num_unsaved_files,
1179 CXTranslationUnit_DetailedPreprocessingRecord);
1180}
1181
1182CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx,
1183 const char *source_filename,
1184 const char **command_line_args,
1185 int num_command_line_args,
1186 struct CXUnsavedFile *unsaved_files,
1187 unsigned num_unsaved_files,
1188 unsigned options) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001189 if (!CIdx)
1190 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001191
Steve Naroffe56b4ba2009-10-20 14:46:24 +00001192 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
1193
Douglas Gregor44c181a2010-07-23 00:33:23 +00001194 // The "editing" option implies other options.
1195 if (options & CXTranslationUnit_Editing)
1196 options |= CXTranslationUnit_PrecompiledPreamble;
1197 bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
1198
Douglas Gregor5352ac02010-01-28 00:27:43 +00001199 // Configure the diagnostics.
1200 DiagnosticOptions DiagOpts;
Douglas Gregor28019772010-04-05 23:52:57 +00001201 llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
1202 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001203
Douglas Gregor4db64a42010-01-23 00:14:00 +00001204 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
1205 for (unsigned I = 0; I != num_unsaved_files; ++I) {
Chris Lattnera0a270c2010-04-05 22:42:27 +00001206 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001207 const llvm::MemoryBuffer *Buffer
Chris Lattnera0a270c2010-04-05 22:42:27 +00001208 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
Douglas Gregor4db64a42010-01-23 00:14:00 +00001209 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
1210 Buffer));
1211 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001212
Daniel Dunbar8506dde2009-12-03 01:54:28 +00001213 if (!CXXIdx->getUseExternalASTGeneration()) {
1214 llvm::SmallVector<const char *, 16> Args;
1215
1216 // The 'source_filename' argument is optional. If the caller does not
1217 // specify it then it is assumed that the source file is specified
1218 // in the actual argument list.
1219 if (source_filename)
1220 Args.push_back(source_filename);
Douglas Gregor52ddc5d2010-07-09 18:39:07 +00001221
1222 // Since the Clang C library is primarily used by batch tools dealing with
1223 // (often very broken) source code, where spell-checking can have a
1224 // significant negative impact on performance (particularly when
1225 // precompiled headers are involved), we disable it by default.
1226 // Note that we place this argument early in the list, so that it can be
1227 // overridden by the caller with "-fspell-checking".
Douglas Gregora0068fc2010-07-09 17:35:33 +00001228 Args.push_back("-fno-spell-checking");
Douglas Gregor52ddc5d2010-07-09 18:39:07 +00001229
Daniel Dunbar8506dde2009-12-03 01:54:28 +00001230 Args.insert(Args.end(), command_line_args,
1231 command_line_args + num_command_line_args);
Douglas Gregor5a430212010-07-21 18:52:53 +00001232
Douglas Gregor44c181a2010-07-23 00:33:23 +00001233 // Do we need the detailed preprocessing record?
Douglas Gregor5a430212010-07-21 18:52:53 +00001234 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
1235 Args.push_back("-Xclang");
1236 Args.push_back("-detailed-preprocessing-record");
1237 }
Douglas Gregor44c181a2010-07-23 00:33:23 +00001238
Douglas Gregor5352ac02010-01-28 00:27:43 +00001239 unsigned NumErrors = Diags->getNumErrors();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001240
Ted Kremenek29b72842010-01-07 22:49:05 +00001241#ifdef USE_CRASHTRACER
1242 ArgsCrashTracerInfo ACTI(Args);
Ted Kremenek8a8da7d2010-01-06 03:42:32 +00001243#endif
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001244
Daniel Dunbar94220972009-12-05 02:17:18 +00001245 llvm::OwningPtr<ASTUnit> Unit(
1246 ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(),
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001247 Diags,
Daniel Dunbar869824e2009-12-13 03:46:13 +00001248 CXXIdx->getClangResourcesPath(),
Daniel Dunbar94220972009-12-05 02:17:18 +00001249 CXXIdx->getOnlyLocalDecls(),
Douglas Gregor4db64a42010-01-23 00:14:00 +00001250 RemappedFiles.data(),
Douglas Gregora88084b2010-02-18 18:08:43 +00001251 RemappedFiles.size(),
Douglas Gregor44c181a2010-07-23 00:33:23 +00001252 /*CaptureDiagnostics=*/true,
1253 PrecompilePreamble));
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001254
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001255 if (NumErrors != Diags->getNumErrors()) {
Ted Kremenek34f6a322010-03-05 22:43:29 +00001256 // Make sure to check that 'Unit' is non-NULL.
1257 if (CXXIdx->getDisplayDiagnostics() && Unit.get()) {
Douglas Gregor405634b2010-04-05 18:10:21 +00001258 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
1259 DEnd = Unit->stored_diag_end();
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001260 D != DEnd; ++D) {
1261 CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions());
Douglas Gregor274f1902010-02-22 23:17:23 +00001262 CXString Msg = clang_formatDiagnostic(&Diag,
1263 clang_defaultDiagnosticDisplayOptions());
1264 fprintf(stderr, "%s\n", clang_getCString(Msg));
1265 clang_disposeString(Msg);
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001266 }
Douglas Gregor274f1902010-02-22 23:17:23 +00001267#ifdef LLVM_ON_WIN32
1268 // On Windows, force a flush, since there may be multiple copies of
1269 // stderr and stdout in the file system, all with different buffers
1270 // but writing to the same device.
1271 fflush(stderr);
Ted Kremenek83c51842010-03-26 01:34:51 +00001272#endif
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001273 }
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001274 }
Daniel Dunbar94220972009-12-05 02:17:18 +00001275
1276 return Unit.take();
Daniel Dunbar8506dde2009-12-03 01:54:28 +00001277 }
1278
Ted Kremenek139ba862009-10-22 00:03:57 +00001279 // Build up the arguments for invoking 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +00001280 std::vector<const char *> argv;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001281
Ted Kremenek139ba862009-10-22 00:03:57 +00001282 // First add the complete path to the 'clang' executable.
1283 llvm::sys::Path ClangPath = static_cast<CIndexer *>(CIdx)->getClangPath();
Benjamin Kramer5e4bc592009-10-18 16:11:04 +00001284 argv.push_back(ClangPath.c_str());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001285
Ted Kremenek139ba862009-10-22 00:03:57 +00001286 // Add the '-emit-ast' option as our execution mode for 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +00001287 argv.push_back("-emit-ast");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001288
Ted Kremenek139ba862009-10-22 00:03:57 +00001289 // The 'source_filename' argument is optional. If the caller does not
1290 // specify it then it is assumed that the source file is specified
1291 // in the actual argument list.
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001292 if (source_filename)
1293 argv.push_back(source_filename);
Ted Kremenek139ba862009-10-22 00:03:57 +00001294
Steve Naroff37b5ac22009-10-15 20:50:09 +00001295 // Generate a temporary name for the AST file.
Ted Kremenek139ba862009-10-22 00:03:57 +00001296 argv.push_back("-o");
Benjamin Kramerc2a98162010-03-13 21:22:49 +00001297 char astTmpFile[L_tmpnam];
1298 argv.push_back(tmpnam(astTmpFile));
Douglas Gregor52ddc5d2010-07-09 18:39:07 +00001299
1300 // Since the Clang C library is primarily used by batch tools dealing with
1301 // (often very broken) source code, where spell-checking can have a
1302 // significant negative impact on performance (particularly when
1303 // precompiled headers are involved), we disable it by default.
1304 // Note that we place this argument early in the list, so that it can be
1305 // overridden by the caller with "-fspell-checking".
Douglas Gregora0068fc2010-07-09 17:35:33 +00001306 argv.push_back("-fno-spell-checking");
Ted Kremenek139ba862009-10-22 00:03:57 +00001307
Douglas Gregor4db64a42010-01-23 00:14:00 +00001308 // Remap any unsaved files to temporary files.
1309 std::vector<llvm::sys::Path> TemporaryFiles;
1310 std::vector<std::string> RemapArgs;
1311 if (RemapFiles(num_unsaved_files, unsaved_files, RemapArgs, TemporaryFiles))
1312 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001313
Douglas Gregor4db64a42010-01-23 00:14:00 +00001314 // The pointers into the elements of RemapArgs are stable because we
1315 // won't be adding anything to RemapArgs after this point.
1316 for (unsigned i = 0, e = RemapArgs.size(); i != e; ++i)
1317 argv.push_back(RemapArgs[i].c_str());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001318
Ted Kremenek139ba862009-10-22 00:03:57 +00001319 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
1320 for (int i = 0; i < num_command_line_args; ++i)
1321 if (const char *arg = command_line_args[i]) {
1322 if (strcmp(arg, "-o") == 0) {
1323 ++i; // Also skip the matching argument.
1324 continue;
1325 }
1326 if (strcmp(arg, "-emit-ast") == 0 ||
1327 strcmp(arg, "-c") == 0 ||
1328 strcmp(arg, "-fsyntax-only") == 0) {
1329 continue;
1330 }
1331
1332 // Keep the argument.
1333 argv.push_back(arg);
Steve Naroffe56b4ba2009-10-20 14:46:24 +00001334 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001335
Douglas Gregord93256e2010-01-28 06:00:51 +00001336 // Generate a temporary name for the diagnostics file.
Benjamin Kramerc2a98162010-03-13 21:22:49 +00001337 char tmpFileResults[L_tmpnam];
1338 char *tmpResultsFileName = tmpnam(tmpFileResults);
1339 llvm::sys::Path DiagnosticsFile(tmpResultsFileName);
Douglas Gregord93256e2010-01-28 06:00:51 +00001340 TemporaryFiles.push_back(DiagnosticsFile);
1341 argv.push_back("-fdiagnostics-binary");
1342
Douglas Gregor44c181a2010-07-23 00:33:23 +00001343 // Do we need the detailed preprocessing record?
1344 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
1345 argv.push_back("-Xclang");
1346 argv.push_back("-detailed-preprocessing-record");
1347 }
1348
Ted Kremenek139ba862009-10-22 00:03:57 +00001349 // Add the null terminator.
Ted Kremenek74cd0692009-10-15 23:21:22 +00001350 argv.push_back(NULL);
1351
Ted Kremenekfeb15e32009-10-26 22:14:08 +00001352 // Invoke 'clang'.
1353 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
1354 // on Unix or NUL (Windows).
Ted Kremenek379afec2009-10-22 03:24:01 +00001355 std::string ErrMsg;
Douglas Gregord93256e2010-01-28 06:00:51 +00001356 const llvm::sys::Path *Redirects[] = { &DevNull, &DevNull, &DiagnosticsFile,
1357 NULL };
Ted Kremenek379afec2009-10-22 03:24:01 +00001358 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
Douglas Gregor936ea3b2010-01-28 00:56:43 +00001359 /* redirects */ &Redirects[0],
Ted Kremenek379afec2009-10-22 03:24:01 +00001360 /* secondsToWait */ 0, /* memoryLimits */ 0, &ErrMsg);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001361
Douglas Gregor936ea3b2010-01-28 00:56:43 +00001362 if (!ErrMsg.empty()) {
1363 std::string AllArgs;
Ted Kremenek379afec2009-10-22 03:24:01 +00001364 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
Douglas Gregor936ea3b2010-01-28 00:56:43 +00001365 I != E; ++I) {
1366 AllArgs += ' ';
Ted Kremenek779e5f42009-10-26 22:08:39 +00001367 if (*I)
Douglas Gregor936ea3b2010-01-28 00:56:43 +00001368 AllArgs += *I;
Ted Kremenek779e5f42009-10-26 22:08:39 +00001369 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001370
Daniel Dunbar32141c82010-02-23 20:23:45 +00001371 Diags->Report(diag::err_fe_invoking) << AllArgs << ErrMsg;
Ted Kremenek379afec2009-10-22 03:24:01 +00001372 }
Benjamin Kramer0829a832009-10-18 11:19:36 +00001373
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001374 ASTUnit *ATU = ASTUnit::LoadFromPCHFile(astTmpFile, Diags,
Douglas Gregor4db64a42010-01-23 00:14:00 +00001375 CXXIdx->getOnlyLocalDecls(),
Douglas Gregor4db64a42010-01-23 00:14:00 +00001376 RemappedFiles.data(),
Douglas Gregora88084b2010-02-18 18:08:43 +00001377 RemappedFiles.size(),
1378 /*CaptureDiagnostics=*/true);
Douglas Gregora88084b2010-02-18 18:08:43 +00001379 if (ATU) {
1380 LoadSerializedDiagnostics(DiagnosticsFile,
1381 num_unsaved_files, unsaved_files,
1382 ATU->getFileManager(),
1383 ATU->getSourceManager(),
Douglas Gregor405634b2010-04-05 18:10:21 +00001384 ATU->getStoredDiagnostics());
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001385 } else if (CXXIdx->getDisplayDiagnostics()) {
1386 // We failed to load the ASTUnit, but we can still deserialize the
1387 // diagnostics and emit them.
1388 FileManager FileMgr;
Douglas Gregorf715ca12010-03-16 00:06:06 +00001389 Diagnostic Diag;
1390 SourceManager SourceMgr(Diag);
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001391 // FIXME: Faked LangOpts!
1392 LangOptions LangOpts;
1393 llvm::SmallVector<StoredDiagnostic, 4> Diags;
1394 LoadSerializedDiagnostics(DiagnosticsFile,
1395 num_unsaved_files, unsaved_files,
1396 FileMgr, SourceMgr, Diags);
1397 for (llvm::SmallVector<StoredDiagnostic, 4>::iterator D = Diags.begin(),
1398 DEnd = Diags.end();
1399 D != DEnd; ++D) {
1400 CXStoredDiagnostic Diag(*D, LangOpts);
Douglas Gregor274f1902010-02-22 23:17:23 +00001401 CXString Msg = clang_formatDiagnostic(&Diag,
1402 clang_defaultDiagnosticDisplayOptions());
1403 fprintf(stderr, "%s\n", clang_getCString(Msg));
1404 clang_disposeString(Msg);
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001405 }
Douglas Gregor274f1902010-02-22 23:17:23 +00001406
1407#ifdef LLVM_ON_WIN32
1408 // On Windows, force a flush, since there may be multiple copies of
1409 // stderr and stdout in the file system, all with different buffers
1410 // but writing to the same device.
1411 fflush(stderr);
1412#endif
Douglas Gregora88084b2010-02-18 18:08:43 +00001413 }
Douglas Gregord93256e2010-01-28 06:00:51 +00001414
Douglas Gregor313e26c2010-02-18 23:35:40 +00001415 if (ATU) {
1416 // Make the translation unit responsible for destroying all temporary files.
1417 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i)
1418 ATU->addTemporaryFile(TemporaryFiles[i]);
1419 ATU->addTemporaryFile(llvm::sys::Path(ATU->getPCHFileName()));
1420 } else {
1421 // Destroy all of the temporary files now; they can't be referenced any
1422 // longer.
1423 llvm::sys::Path(astTmpFile).eraseFromDisk();
1424 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i)
1425 TemporaryFiles[i].eraseFromDisk();
1426 }
1427
Steve Naroffe19944c2009-10-15 22:23:48 +00001428 return ATU;
Steve Naroff5b7d8e22009-10-15 20:04:39 +00001429}
1430
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001431void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001432 if (CTUnit)
1433 delete static_cast<ASTUnit *>(CTUnit);
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00001434}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001435
Douglas Gregorabc563f2010-07-19 21:46:24 +00001436int clang_reparseTranslationUnit(CXTranslationUnit TU,
1437 unsigned num_unsaved_files,
1438 struct CXUnsavedFile *unsaved_files) {
1439 if (!TU)
1440 return 1;
1441
1442 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
1443 for (unsigned I = 0; I != num_unsaved_files; ++I) {
1444 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
1445 const llvm::MemoryBuffer *Buffer
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001446 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
Douglas Gregorabc563f2010-07-19 21:46:24 +00001447 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
1448 Buffer));
1449 }
1450
1451 return static_cast<ASTUnit *>(TU)->Reparse(RemappedFiles.data(),
1452 RemappedFiles.size())? 1 : 0;
1453}
1454
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001455CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001456 if (!CTUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001457 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001458
Steve Naroff77accc12009-09-03 18:19:54 +00001459 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001460 return createCXString(CXXUnit->getOriginalSourceFileName(), true);
Steve Naroffaf08ddc2009-09-03 15:49:00 +00001461}
Daniel Dunbar1eb79b52009-08-28 16:30:07 +00001462
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00001463CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001464 CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } };
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00001465 return Result;
1466}
1467
Ted Kremenekfb480492010-01-13 21:46:36 +00001468} // end: extern "C"
Steve Naroff600866c2009-08-27 19:51:58 +00001469
Ted Kremenekfb480492010-01-13 21:46:36 +00001470//===----------------------------------------------------------------------===//
Douglas Gregor1db19de2010-01-19 21:36:55 +00001471// CXSourceLocation and CXSourceRange Operations.
1472//===----------------------------------------------------------------------===//
1473
Douglas Gregorb9790342010-01-22 21:44:22 +00001474extern "C" {
1475CXSourceLocation clang_getNullLocation() {
Douglas Gregor5352ac02010-01-28 00:27:43 +00001476 CXSourceLocation Result = { { 0, 0 }, 0 };
Douglas Gregorb9790342010-01-22 21:44:22 +00001477 return Result;
1478}
1479
1480unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) {
Daniel Dunbar90a6b9e2010-01-30 23:58:27 +00001481 return (loc1.ptr_data[0] == loc2.ptr_data[0] &&
1482 loc1.ptr_data[1] == loc2.ptr_data[1] &&
1483 loc1.int_data == loc2.int_data);
Douglas Gregorb9790342010-01-22 21:44:22 +00001484}
1485
1486CXSourceLocation clang_getLocation(CXTranslationUnit tu,
1487 CXFile file,
1488 unsigned line,
1489 unsigned column) {
Douglas Gregor42748ec2010-04-30 19:45:53 +00001490 if (!tu || !file)
Douglas Gregorb9790342010-01-22 21:44:22 +00001491 return clang_getNullLocation();
Douglas Gregor42748ec2010-04-30 19:45:53 +00001492
Douglas Gregorb9790342010-01-22 21:44:22 +00001493 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
1494 SourceLocation SLoc
1495 = CXXUnit->getSourceManager().getLocation(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001496 static_cast<const FileEntry *>(file),
Douglas Gregorb9790342010-01-22 21:44:22 +00001497 line, column);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001498
Ted Kremenek1a9a0bc2010-06-28 23:54:17 +00001499 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
Douglas Gregorb9790342010-01-22 21:44:22 +00001500}
1501
Douglas Gregor5352ac02010-01-28 00:27:43 +00001502CXSourceRange clang_getNullRange() {
1503 CXSourceRange Result = { { 0, 0 }, 0, 0 };
1504 return Result;
1505}
Daniel Dunbard52864b2010-02-14 10:02:57 +00001506
Douglas Gregor5352ac02010-01-28 00:27:43 +00001507CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) {
1508 if (begin.ptr_data[0] != end.ptr_data[0] ||
1509 begin.ptr_data[1] != end.ptr_data[1])
1510 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001511
1512 CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00001513 begin.int_data, end.int_data };
Douglas Gregorb9790342010-01-22 21:44:22 +00001514 return Result;
1515}
1516
Douglas Gregor46766dc2010-01-26 19:19:08 +00001517void clang_getInstantiationLocation(CXSourceLocation location,
1518 CXFile *file,
1519 unsigned *line,
1520 unsigned *column,
1521 unsigned *offset) {
Douglas Gregor1db19de2010-01-19 21:36:55 +00001522 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
1523
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00001524 if (!location.ptr_data[0] || Loc.isInvalid()) {
Douglas Gregor46766dc2010-01-26 19:19:08 +00001525 if (file)
1526 *file = 0;
1527 if (line)
1528 *line = 0;
1529 if (column)
1530 *column = 0;
1531 if (offset)
1532 *offset = 0;
1533 return;
1534 }
1535
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00001536 const SourceManager &SM =
1537 *static_cast<const SourceManager*>(location.ptr_data[0]);
Douglas Gregor1db19de2010-01-19 21:36:55 +00001538 SourceLocation InstLoc = SM.getInstantiationLoc(Loc);
Douglas Gregor1db19de2010-01-19 21:36:55 +00001539
1540 if (file)
1541 *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc));
1542 if (line)
1543 *line = SM.getInstantiationLineNumber(InstLoc);
1544 if (column)
1545 *column = SM.getInstantiationColumnNumber(InstLoc);
Douglas Gregore69517c2010-01-26 03:07:15 +00001546 if (offset)
Douglas Gregor46766dc2010-01-26 19:19:08 +00001547 *offset = SM.getDecomposedLoc(InstLoc).second;
Douglas Gregore69517c2010-01-26 03:07:15 +00001548}
1549
Douglas Gregor1db19de2010-01-19 21:36:55 +00001550CXSourceLocation clang_getRangeStart(CXSourceRange range) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001551 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00001552 range.begin_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00001553 return Result;
1554}
1555
1556CXSourceLocation clang_getRangeEnd(CXSourceRange range) {
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00001557 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00001558 range.end_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00001559 return Result;
1560}
1561
Douglas Gregorb9790342010-01-22 21:44:22 +00001562} // end: extern "C"
1563
Douglas Gregor1db19de2010-01-19 21:36:55 +00001564//===----------------------------------------------------------------------===//
Ted Kremenekfb480492010-01-13 21:46:36 +00001565// CXFile Operations.
1566//===----------------------------------------------------------------------===//
1567
1568extern "C" {
Ted Kremenek74844072010-02-17 00:41:20 +00001569CXString clang_getFileName(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00001570 if (!SFile)
Ted Kremenek74844072010-02-17 00:41:20 +00001571 return createCXString(NULL);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001572
Steve Naroff88145032009-10-27 14:35:18 +00001573 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
Ted Kremenek74844072010-02-17 00:41:20 +00001574 return createCXString(FEnt->getName());
Steve Naroff88145032009-10-27 14:35:18 +00001575}
1576
1577time_t clang_getFileTime(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00001578 if (!SFile)
1579 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001580
Steve Naroff88145032009-10-27 14:35:18 +00001581 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
1582 return FEnt->getModificationTime();
Steve Naroffee9405e2009-09-25 21:45:39 +00001583}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001584
Douglas Gregorb9790342010-01-22 21:44:22 +00001585CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) {
1586 if (!tu)
1587 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001588
Douglas Gregorb9790342010-01-22 21:44:22 +00001589 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001590
Douglas Gregorb9790342010-01-22 21:44:22 +00001591 FileManager &FMgr = CXXUnit->getFileManager();
1592 const FileEntry *File = FMgr.getFile(file_name, file_name+strlen(file_name));
1593 return const_cast<FileEntry *>(File);
1594}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001595
Ted Kremenekfb480492010-01-13 21:46:36 +00001596} // end: extern "C"
Steve Naroffee9405e2009-09-25 21:45:39 +00001597
Ted Kremenekfb480492010-01-13 21:46:36 +00001598//===----------------------------------------------------------------------===//
1599// CXCursor Operations.
1600//===----------------------------------------------------------------------===//
1601
Ted Kremenekfb480492010-01-13 21:46:36 +00001602static Decl *getDeclFromExpr(Stmt *E) {
1603 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
1604 return RefExpr->getDecl();
1605 if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
1606 return ME->getMemberDecl();
1607 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
1608 return RE->getDecl();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001609
Ted Kremenekfb480492010-01-13 21:46:36 +00001610 if (CallExpr *CE = dyn_cast<CallExpr>(E))
1611 return getDeclFromExpr(CE->getCallee());
1612 if (CastExpr *CE = dyn_cast<CastExpr>(E))
1613 return getDeclFromExpr(CE->getSubExpr());
1614 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
1615 return OME->getMethodDecl();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001616
Ted Kremenekfb480492010-01-13 21:46:36 +00001617 return 0;
1618}
1619
Daniel Dunbarc29f4c32010-02-02 05:00:22 +00001620static SourceLocation getLocationFromExpr(Expr *E) {
1621 if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
1622 return /*FIXME:*/Msg->getLeftLoc();
1623 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
1624 return DRE->getLocation();
1625 if (MemberExpr *Member = dyn_cast<MemberExpr>(E))
1626 return Member->getMemberLoc();
1627 if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
1628 return Ivar->getLocation();
1629 return E->getLocStart();
1630}
1631
Ted Kremenekfb480492010-01-13 21:46:36 +00001632extern "C" {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001633
1634unsigned clang_visitChildren(CXCursor parent,
Douglas Gregorb1373d02010-01-20 20:59:29 +00001635 CXCursorVisitor visitor,
1636 CXClientData client_data) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001637 ASTUnit *CXXUnit = getCursorASTUnit(parent);
Douglas Gregorb1373d02010-01-20 20:59:29 +00001638
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001639 CursorVisitor CursorVis(CXXUnit, visitor, client_data,
1640 CXXUnit->getMaxPCHLevel());
Douglas Gregorb1373d02010-01-20 20:59:29 +00001641 return CursorVis.VisitChildren(parent);
1642}
1643
Douglas Gregor78205d42010-01-20 21:45:58 +00001644static CXString getDeclSpelling(Decl *D) {
1645 NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D);
1646 if (!ND)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001647 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001648
Douglas Gregor78205d42010-01-20 21:45:58 +00001649 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001650 return createCXString(OMD->getSelector().getAsString());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001651
Douglas Gregor78205d42010-01-20 21:45:58 +00001652 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
1653 // No, this isn't the same as the code below. getIdentifier() is non-virtual
1654 // and returns different names. NamedDecl returns the class name and
1655 // ObjCCategoryImplDecl returns the category name.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001656 return createCXString(CIMP->getIdentifier()->getNameStart());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001657
Ted Kremenek50aa6ac2010-05-19 21:51:10 +00001658 llvm::SmallString<1024> S;
1659 llvm::raw_svector_ostream os(S);
1660 ND->printName(os);
1661
1662 return createCXString(os.str());
Douglas Gregor78205d42010-01-20 21:45:58 +00001663}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001664
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001665CXString clang_getCursorSpelling(CXCursor C) {
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00001666 if (clang_isTranslationUnit(C.kind))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001667 return clang_getTranslationUnitSpelling(C.data[2]);
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00001668
Steve Narofff334b4e2009-09-02 18:26:48 +00001669 if (clang_isReference(C.kind)) {
1670 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +00001671 case CXCursor_ObjCSuperClassRef: {
Douglas Gregor2e331b92010-01-16 14:00:32 +00001672 ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001673 return createCXString(Super->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00001674 }
1675 case CXCursor_ObjCClassRef: {
Douglas Gregor1adb0822010-01-16 17:14:40 +00001676 ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001677 return createCXString(Class->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00001678 }
1679 case CXCursor_ObjCProtocolRef: {
Douglas Gregor78db0cd2010-01-16 15:44:18 +00001680 ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
Douglas Gregorf46034a2010-01-18 23:41:10 +00001681 assert(OID && "getCursorSpelling(): Missing protocol decl");
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001682 return createCXString(OID->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00001683 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001684 case CXCursor_TypeRef: {
1685 TypeDecl *Type = getCursorTypeRef(C).first;
1686 assert(Type && "Missing type decl");
1687
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001688 return createCXString(getCursorContext(C).getTypeDeclType(Type).
1689 getAsString());
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001690 }
1691
Daniel Dunbaracca7252009-11-30 20:42:49 +00001692 default:
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001693 return createCXString("<not implemented>");
Steve Narofff334b4e2009-09-02 18:26:48 +00001694 }
1695 }
Douglas Gregor97b98722010-01-19 23:20:36 +00001696
1697 if (clang_isExpression(C.kind)) {
1698 Decl *D = getDeclFromExpr(getCursorExpr(C));
1699 if (D)
Douglas Gregor78205d42010-01-20 21:45:58 +00001700 return getDeclSpelling(D);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001701 return createCXString("");
Douglas Gregor97b98722010-01-19 23:20:36 +00001702 }
1703
Douglas Gregor4ae8f292010-03-18 17:52:52 +00001704 if (C.kind == CXCursor_MacroInstantiation)
1705 return createCXString(getCursorMacroInstantiation(C)->getName()
1706 ->getNameStart());
1707
Douglas Gregor572feb22010-03-18 18:04:21 +00001708 if (C.kind == CXCursor_MacroDefinition)
1709 return createCXString(getCursorMacroDefinition(C)->getName()
1710 ->getNameStart());
1711
Douglas Gregor60cbfac2010-01-25 16:56:17 +00001712 if (clang_isDeclaration(C.kind))
1713 return getDeclSpelling(getCursorDecl(C));
Ted Kremeneke68fff62010-02-17 00:41:32 +00001714
Ted Kremenekee4db4f2010-02-17 00:41:08 +00001715 return createCXString("");
Steve Narofff334b4e2009-09-02 18:26:48 +00001716}
1717
Ted Kremeneke68fff62010-02-17 00:41:32 +00001718CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
Steve Naroff89922f82009-08-31 00:59:03 +00001719 switch (Kind) {
Ted Kremeneke68fff62010-02-17 00:41:32 +00001720 case CXCursor_FunctionDecl:
1721 return createCXString("FunctionDecl");
1722 case CXCursor_TypedefDecl:
1723 return createCXString("TypedefDecl");
1724 case CXCursor_EnumDecl:
1725 return createCXString("EnumDecl");
1726 case CXCursor_EnumConstantDecl:
1727 return createCXString("EnumConstantDecl");
1728 case CXCursor_StructDecl:
1729 return createCXString("StructDecl");
1730 case CXCursor_UnionDecl:
1731 return createCXString("UnionDecl");
1732 case CXCursor_ClassDecl:
1733 return createCXString("ClassDecl");
1734 case CXCursor_FieldDecl:
1735 return createCXString("FieldDecl");
1736 case CXCursor_VarDecl:
1737 return createCXString("VarDecl");
1738 case CXCursor_ParmDecl:
1739 return createCXString("ParmDecl");
1740 case CXCursor_ObjCInterfaceDecl:
1741 return createCXString("ObjCInterfaceDecl");
1742 case CXCursor_ObjCCategoryDecl:
1743 return createCXString("ObjCCategoryDecl");
1744 case CXCursor_ObjCProtocolDecl:
1745 return createCXString("ObjCProtocolDecl");
1746 case CXCursor_ObjCPropertyDecl:
1747 return createCXString("ObjCPropertyDecl");
1748 case CXCursor_ObjCIvarDecl:
1749 return createCXString("ObjCIvarDecl");
1750 case CXCursor_ObjCInstanceMethodDecl:
1751 return createCXString("ObjCInstanceMethodDecl");
1752 case CXCursor_ObjCClassMethodDecl:
1753 return createCXString("ObjCClassMethodDecl");
1754 case CXCursor_ObjCImplementationDecl:
1755 return createCXString("ObjCImplementationDecl");
1756 case CXCursor_ObjCCategoryImplDecl:
1757 return createCXString("ObjCCategoryImplDecl");
Ted Kremenek8bd5a692010-04-13 23:39:06 +00001758 case CXCursor_CXXMethod:
1759 return createCXString("CXXMethod");
Ted Kremeneke68fff62010-02-17 00:41:32 +00001760 case CXCursor_UnexposedDecl:
1761 return createCXString("UnexposedDecl");
1762 case CXCursor_ObjCSuperClassRef:
1763 return createCXString("ObjCSuperClassRef");
1764 case CXCursor_ObjCProtocolRef:
1765 return createCXString("ObjCProtocolRef");
1766 case CXCursor_ObjCClassRef:
1767 return createCXString("ObjCClassRef");
1768 case CXCursor_TypeRef:
1769 return createCXString("TypeRef");
1770 case CXCursor_UnexposedExpr:
1771 return createCXString("UnexposedExpr");
Ted Kremenek1ee6cad2010-04-11 21:47:37 +00001772 case CXCursor_BlockExpr:
1773 return createCXString("BlockExpr");
Ted Kremeneke68fff62010-02-17 00:41:32 +00001774 case CXCursor_DeclRefExpr:
1775 return createCXString("DeclRefExpr");
1776 case CXCursor_MemberRefExpr:
1777 return createCXString("MemberRefExpr");
1778 case CXCursor_CallExpr:
1779 return createCXString("CallExpr");
1780 case CXCursor_ObjCMessageExpr:
1781 return createCXString("ObjCMessageExpr");
1782 case CXCursor_UnexposedStmt:
1783 return createCXString("UnexposedStmt");
1784 case CXCursor_InvalidFile:
1785 return createCXString("InvalidFile");
Ted Kremenek292db642010-03-19 20:39:05 +00001786 case CXCursor_InvalidCode:
1787 return createCXString("InvalidCode");
Ted Kremeneke68fff62010-02-17 00:41:32 +00001788 case CXCursor_NoDeclFound:
1789 return createCXString("NoDeclFound");
1790 case CXCursor_NotImplemented:
1791 return createCXString("NotImplemented");
1792 case CXCursor_TranslationUnit:
1793 return createCXString("TranslationUnit");
Ted Kremeneke77f4432010-02-18 03:09:07 +00001794 case CXCursor_UnexposedAttr:
1795 return createCXString("UnexposedAttr");
1796 case CXCursor_IBActionAttr:
1797 return createCXString("attribute(ibaction)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001798 case CXCursor_IBOutletAttr:
1799 return createCXString("attribute(iboutlet)");
Ted Kremenek857e9182010-05-19 17:38:06 +00001800 case CXCursor_IBOutletCollectionAttr:
1801 return createCXString("attribute(iboutletcollection)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001802 case CXCursor_PreprocessingDirective:
1803 return createCXString("preprocessing directive");
Douglas Gregor572feb22010-03-18 18:04:21 +00001804 case CXCursor_MacroDefinition:
1805 return createCXString("macro definition");
Douglas Gregor48072312010-03-18 15:23:44 +00001806 case CXCursor_MacroInstantiation:
1807 return createCXString("macro instantiation");
Ted Kremenek8f06e0e2010-05-06 23:38:21 +00001808 case CXCursor_Namespace:
1809 return createCXString("Namespace");
Ted Kremeneka0536d82010-05-07 01:04:29 +00001810 case CXCursor_LinkageSpec:
1811 return createCXString("LinkageSpec");
Steve Naroff89922f82009-08-31 00:59:03 +00001812 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001813
Ted Kremenekdeb06bd2010-01-16 02:02:09 +00001814 llvm_unreachable("Unhandled CXCursorKind");
Ted Kremeneke68fff62010-02-17 00:41:32 +00001815 return createCXString(NULL);
Steve Naroff600866c2009-08-27 19:51:58 +00001816}
Steve Naroff89922f82009-08-31 00:59:03 +00001817
Ted Kremeneke68fff62010-02-17 00:41:32 +00001818enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
1819 CXCursor parent,
Douglas Gregor33e9abd2010-01-22 19:49:59 +00001820 CXClientData client_data) {
1821 CXCursor *BestCursor = static_cast<CXCursor *>(client_data);
1822 *BestCursor = cursor;
1823 return CXChildVisit_Recurse;
1824}
Ted Kremeneke68fff62010-02-17 00:41:32 +00001825
Douglas Gregorb9790342010-01-22 21:44:22 +00001826CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
1827 if (!TU)
Ted Kremenekf4629892010-01-14 01:51:23 +00001828 return clang_getNullCursor();
Ted Kremeneke68fff62010-02-17 00:41:32 +00001829
Douglas Gregorb9790342010-01-22 21:44:22 +00001830 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
Douglas Gregorbdf60622010-03-05 21:16:25 +00001831 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
1832
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00001833 // Translate the given source location to make it point at the beginning of
1834 // the token under the cursor.
Ted Kremeneka297de22010-01-25 22:34:44 +00001835 SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
Ted Kremeneka629ea42010-07-29 00:52:07 +00001836
1837 // Guard against an invalid SourceLocation, or we may assert in one
1838 // of the following calls.
1839 if (SLoc.isInvalid())
1840 return clang_getNullCursor();
1841
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00001842 SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
1843 CXXUnit->getASTContext().getLangOptions());
1844
Douglas Gregor33e9abd2010-01-22 19:49:59 +00001845 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
1846 if (SLoc.isValid()) {
Douglas Gregor33e9abd2010-01-22 19:49:59 +00001847 // FIXME: Would be great to have a "hint" cursor, then walk from that
1848 // hint cursor upward until we find a cursor whose source range encloses
1849 // the region of interest, rather than starting from the translation unit.
1850 CXCursor Parent = clang_getTranslationUnitCursor(CXXUnit);
Ted Kremeneke68fff62010-02-17 00:41:32 +00001851 CursorVisitor CursorVis(CXXUnit, GetCursorVisitor, &Result,
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00001852 Decl::MaxPCHLevel, SourceLocation(SLoc));
Douglas Gregor33e9abd2010-01-22 19:49:59 +00001853 CursorVis.VisitChildren(Parent);
Steve Naroff77128dd2009-09-15 20:25:34 +00001854 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001855 return Result;
Steve Naroff600866c2009-08-27 19:51:58 +00001856}
1857
Ted Kremenek73885552009-11-17 19:28:59 +00001858CXCursor clang_getNullCursor(void) {
Douglas Gregor5bfb8c12010-01-20 23:34:41 +00001859 return MakeCXCursorInvalid(CXCursor_InvalidFile);
Ted Kremenek73885552009-11-17 19:28:59 +00001860}
1861
1862unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
Douglas Gregor283cae32010-01-15 21:56:13 +00001863 return X == Y;
Ted Kremenek73885552009-11-17 19:28:59 +00001864}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001865
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001866unsigned clang_isInvalid(enum CXCursorKind K) {
Steve Naroff77128dd2009-09-15 20:25:34 +00001867 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
1868}
1869
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001870unsigned clang_isDeclaration(enum CXCursorKind K) {
Steve Naroff89922f82009-08-31 00:59:03 +00001871 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
1872}
Steve Naroff2d4d6292009-08-31 14:26:51 +00001873
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001874unsigned clang_isReference(enum CXCursorKind K) {
Steve Narofff334b4e2009-09-02 18:26:48 +00001875 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
1876}
1877
Douglas Gregor97b98722010-01-19 23:20:36 +00001878unsigned clang_isExpression(enum CXCursorKind K) {
1879 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
1880}
1881
1882unsigned clang_isStatement(enum CXCursorKind K) {
1883 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
1884}
1885
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00001886unsigned clang_isTranslationUnit(enum CXCursorKind K) {
1887 return K == CXCursor_TranslationUnit;
1888}
1889
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001890unsigned clang_isPreprocessing(enum CXCursorKind K) {
1891 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
1892}
1893
Ted Kremenekad6eff62010-03-08 21:17:29 +00001894unsigned clang_isUnexposed(enum CXCursorKind K) {
1895 switch (K) {
1896 case CXCursor_UnexposedDecl:
1897 case CXCursor_UnexposedExpr:
1898 case CXCursor_UnexposedStmt:
1899 case CXCursor_UnexposedAttr:
1900 return true;
1901 default:
1902 return false;
1903 }
1904}
1905
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001906CXCursorKind clang_getCursorKind(CXCursor C) {
Steve Naroff9efa7672009-09-04 15:44:05 +00001907 return C.kind;
1908}
1909
Douglas Gregor98258af2010-01-18 22:46:11 +00001910CXSourceLocation clang_getCursorLocation(CXCursor C) {
1911 if (clang_isReference(C.kind)) {
Douglas Gregorf46034a2010-01-18 23:41:10 +00001912 switch (C.kind) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001913 case CXCursor_ObjCSuperClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00001914 std::pair<ObjCInterfaceDecl *, SourceLocation> P
1915 = getCursorObjCSuperClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00001916 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001917 }
1918
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001919 case CXCursor_ObjCProtocolRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00001920 std::pair<ObjCProtocolDecl *, SourceLocation> P
1921 = getCursorObjCProtocolRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00001922 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001923 }
1924
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001925 case CXCursor_ObjCClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00001926 std::pair<ObjCInterfaceDecl *, SourceLocation> P
1927 = getCursorObjCClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00001928 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001929 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001930
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001931 case CXCursor_TypeRef: {
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001932 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00001933 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001934 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001935
Douglas Gregorf46034a2010-01-18 23:41:10 +00001936 default:
1937 // FIXME: Need a way to enumerate all non-reference cases.
1938 llvm_unreachable("Missed a reference kind");
1939 }
Douglas Gregor98258af2010-01-18 22:46:11 +00001940 }
Douglas Gregor97b98722010-01-19 23:20:36 +00001941
1942 if (clang_isExpression(C.kind))
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001943 return cxloc::translateSourceLocation(getCursorContext(C),
Douglas Gregor97b98722010-01-19 23:20:36 +00001944 getLocationFromExpr(getCursorExpr(C)));
1945
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001946 if (C.kind == CXCursor_PreprocessingDirective) {
1947 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
1948 return cxloc::translateSourceLocation(getCursorContext(C), L);
1949 }
Douglas Gregor48072312010-03-18 15:23:44 +00001950
1951 if (C.kind == CXCursor_MacroInstantiation) {
Douglas Gregor4ae8f292010-03-18 17:52:52 +00001952 SourceLocation L
1953 = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin();
Douglas Gregor48072312010-03-18 15:23:44 +00001954 return cxloc::translateSourceLocation(getCursorContext(C), L);
1955 }
Douglas Gregor572feb22010-03-18 18:04:21 +00001956
1957 if (C.kind == CXCursor_MacroDefinition) {
1958 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
1959 return cxloc::translateSourceLocation(getCursorContext(C), L);
1960 }
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00001961
Ted Kremenek9a700d22010-05-12 06:16:13 +00001962 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
Douglas Gregor5352ac02010-01-28 00:27:43 +00001963 return clang_getNullLocation();
Douglas Gregor98258af2010-01-18 22:46:11 +00001964
Douglas Gregorf46034a2010-01-18 23:41:10 +00001965 Decl *D = getCursorDecl(C);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001966 SourceLocation Loc = D->getLocation();
1967 if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D))
1968 Loc = Class->getClassLoc();
Douglas Gregor2ca54fe2010-03-22 15:53:50 +00001969 return cxloc::translateSourceLocation(getCursorContext(C), Loc);
Douglas Gregor98258af2010-01-18 22:46:11 +00001970}
Douglas Gregora7bde202010-01-19 00:34:46 +00001971
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00001972} // end extern "C"
1973
1974static SourceRange getRawCursorExtent(CXCursor C) {
Douglas Gregora7bde202010-01-19 00:34:46 +00001975 if (clang_isReference(C.kind)) {
1976 switch (C.kind) {
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00001977 case CXCursor_ObjCSuperClassRef:
1978 return getCursorObjCSuperClassRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001979
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00001980 case CXCursor_ObjCProtocolRef:
1981 return getCursorObjCProtocolRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001982
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00001983 case CXCursor_ObjCClassRef:
1984 return getCursorObjCClassRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001985
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00001986 case CXCursor_TypeRef:
1987 return getCursorTypeRef(C).second;
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001988
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00001989 default:
1990 // FIXME: Need a way to enumerate all non-reference cases.
1991 llvm_unreachable("Missed a reference kind");
Douglas Gregora7bde202010-01-19 00:34:46 +00001992 }
1993 }
Douglas Gregor97b98722010-01-19 23:20:36 +00001994
1995 if (clang_isExpression(C.kind))
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00001996 return getCursorExpr(C)->getSourceRange();
Douglas Gregor33e9abd2010-01-22 19:49:59 +00001997
1998 if (clang_isStatement(C.kind))
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00001999 return getCursorStmt(C)->getSourceRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002000
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002001 if (C.kind == CXCursor_PreprocessingDirective)
2002 return cxcursor::getCursorPreprocessingDirective(C);
Douglas Gregor48072312010-03-18 15:23:44 +00002003
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002004 if (C.kind == CXCursor_MacroInstantiation)
2005 return cxcursor::getCursorMacroInstantiation(C)->getSourceRange();
Douglas Gregor572feb22010-03-18 18:04:21 +00002006
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002007 if (C.kind == CXCursor_MacroDefinition)
2008 return cxcursor::getCursorMacroDefinition(C)->getSourceRange();
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002009
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002010 if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl)
2011 return getCursorDecl(C)->getSourceRange();
2012
2013 return SourceRange();
2014}
2015
2016extern "C" {
2017
2018CXSourceRange clang_getCursorExtent(CXCursor C) {
2019 SourceRange R = getRawCursorExtent(C);
2020 if (R.isInvalid())
Douglas Gregor5352ac02010-01-28 00:27:43 +00002021 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002022
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002023 return cxloc::translateSourceRange(getCursorContext(C), R);
Douglas Gregora7bde202010-01-19 00:34:46 +00002024}
Douglas Gregorc5d1e932010-01-19 01:20:04 +00002025
2026CXCursor clang_getCursorReferenced(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002027 if (clang_isInvalid(C.kind))
2028 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002029
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002030 ASTUnit *CXXUnit = getCursorASTUnit(C);
Douglas Gregorb6998662010-01-19 19:34:47 +00002031 if (clang_isDeclaration(C.kind))
Douglas Gregorc5d1e932010-01-19 01:20:04 +00002032 return C;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002033
Douglas Gregor97b98722010-01-19 23:20:36 +00002034 if (clang_isExpression(C.kind)) {
2035 Decl *D = getDeclFromExpr(getCursorExpr(C));
2036 if (D)
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002037 return MakeCXCursor(D, CXXUnit);
Douglas Gregor97b98722010-01-19 23:20:36 +00002038 return clang_getNullCursor();
2039 }
2040
Douglas Gregorbf7efa22010-03-18 18:23:03 +00002041 if (C.kind == CXCursor_MacroInstantiation) {
2042 if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition())
2043 return MakeMacroDefinitionCursor(Def, CXXUnit);
2044 }
2045
Douglas Gregorc5d1e932010-01-19 01:20:04 +00002046 if (!clang_isReference(C.kind))
2047 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002048
Douglas Gregorc5d1e932010-01-19 01:20:04 +00002049 switch (C.kind) {
2050 case CXCursor_ObjCSuperClassRef:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002051 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, CXXUnit);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002052
2053 case CXCursor_ObjCProtocolRef: {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002054 return MakeCXCursor(getCursorObjCProtocolRef(C).first, CXXUnit);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002055
2056 case CXCursor_ObjCClassRef:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002057 return MakeCXCursor(getCursorObjCClassRef(C).first, CXXUnit);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002058
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002059 case CXCursor_TypeRef:
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002060 return MakeCXCursor(getCursorTypeRef(C).first, CXXUnit);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002061
Douglas Gregorc5d1e932010-01-19 01:20:04 +00002062 default:
2063 // We would prefer to enumerate all non-reference cursor kinds here.
2064 llvm_unreachable("Unhandled reference cursor kind");
2065 break;
2066 }
2067 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002068
Douglas Gregorc5d1e932010-01-19 01:20:04 +00002069 return clang_getNullCursor();
2070}
2071
Douglas Gregorb6998662010-01-19 19:34:47 +00002072CXCursor clang_getCursorDefinition(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002073 if (clang_isInvalid(C.kind))
2074 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002075
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002076 ASTUnit *CXXUnit = getCursorASTUnit(C);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002077
Douglas Gregorb6998662010-01-19 19:34:47 +00002078 bool WasReference = false;
Douglas Gregor97b98722010-01-19 23:20:36 +00002079 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
Douglas Gregorb6998662010-01-19 19:34:47 +00002080 C = clang_getCursorReferenced(C);
2081 WasReference = true;
2082 }
2083
Douglas Gregorbf7efa22010-03-18 18:23:03 +00002084 if (C.kind == CXCursor_MacroInstantiation)
2085 return clang_getCursorReferenced(C);
2086
Douglas Gregorb6998662010-01-19 19:34:47 +00002087 if (!clang_isDeclaration(C.kind))
2088 return clang_getNullCursor();
2089
2090 Decl *D = getCursorDecl(C);
2091 if (!D)
2092 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002093
Douglas Gregorb6998662010-01-19 19:34:47 +00002094 switch (D->getKind()) {
2095 // Declaration kinds that don't really separate the notions of
2096 // declaration and definition.
2097 case Decl::Namespace:
2098 case Decl::Typedef:
2099 case Decl::TemplateTypeParm:
2100 case Decl::EnumConstant:
2101 case Decl::Field:
2102 case Decl::ObjCIvar:
2103 case Decl::ObjCAtDefsField:
2104 case Decl::ImplicitParam:
2105 case Decl::ParmVar:
2106 case Decl::NonTypeTemplateParm:
2107 case Decl::TemplateTemplateParm:
2108 case Decl::ObjCCategoryImpl:
2109 case Decl::ObjCImplementation:
Abramo Bagnara6206d532010-06-05 05:09:32 +00002110 case Decl::AccessSpec:
Douglas Gregorb6998662010-01-19 19:34:47 +00002111 case Decl::LinkageSpec:
2112 case Decl::ObjCPropertyImpl:
2113 case Decl::FileScopeAsm:
2114 case Decl::StaticAssert:
2115 case Decl::Block:
2116 return C;
2117
2118 // Declaration kinds that don't make any sense here, but are
2119 // nonetheless harmless.
2120 case Decl::TranslationUnit:
Douglas Gregorb6998662010-01-19 19:34:47 +00002121 break;
2122
2123 // Declaration kinds for which the definition is not resolvable.
2124 case Decl::UnresolvedUsingTypename:
2125 case Decl::UnresolvedUsingValue:
2126 break;
2127
2128 case Decl::UsingDirective:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002129 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
2130 CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002131
2132 case Decl::NamespaceAlias:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002133 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002134
2135 case Decl::Enum:
2136 case Decl::Record:
2137 case Decl::CXXRecord:
2138 case Decl::ClassTemplateSpecialization:
2139 case Decl::ClassTemplatePartialSpecialization:
Douglas Gregor952b0172010-02-11 01:04:33 +00002140 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002141 return MakeCXCursor(Def, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002142 return clang_getNullCursor();
2143
2144 case Decl::Function:
2145 case Decl::CXXMethod:
2146 case Decl::CXXConstructor:
2147 case Decl::CXXDestructor:
2148 case Decl::CXXConversion: {
2149 const FunctionDecl *Def = 0;
2150 if (cast<FunctionDecl>(D)->getBody(Def))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002151 return MakeCXCursor(const_cast<FunctionDecl *>(Def), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002152 return clang_getNullCursor();
2153 }
2154
2155 case Decl::Var: {
Sebastian Redl31310a22010-02-01 20:16:42 +00002156 // Ask the variable if it has a definition.
2157 if (VarDecl *Def = cast<VarDecl>(D)->getDefinition())
2158 return MakeCXCursor(Def, CXXUnit);
2159 return clang_getNullCursor();
Douglas Gregorb6998662010-01-19 19:34:47 +00002160 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002161
Douglas Gregorb6998662010-01-19 19:34:47 +00002162 case Decl::FunctionTemplate: {
2163 const FunctionDecl *Def = 0;
2164 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002165 return MakeCXCursor(Def->getDescribedFunctionTemplate(), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002166 return clang_getNullCursor();
2167 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002168
Douglas Gregorb6998662010-01-19 19:34:47 +00002169 case Decl::ClassTemplate: {
2170 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
Douglas Gregor952b0172010-02-11 01:04:33 +00002171 ->getDefinition())
Douglas Gregorb6998662010-01-19 19:34:47 +00002172 return MakeCXCursor(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002173 cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002174 CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002175 return clang_getNullCursor();
2176 }
2177
2178 case Decl::Using: {
2179 UsingDecl *Using = cast<UsingDecl>(D);
2180 CXCursor Def = clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002181 for (UsingDecl::shadow_iterator S = Using->shadow_begin(),
2182 SEnd = Using->shadow_end();
Douglas Gregorb6998662010-01-19 19:34:47 +00002183 S != SEnd; ++S) {
2184 if (Def != clang_getNullCursor()) {
2185 // FIXME: We have no way to return multiple results.
2186 return clang_getNullCursor();
2187 }
2188
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002189 Def = clang_getCursorDefinition(MakeCXCursor((*S)->getTargetDecl(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002190 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00002191 }
2192
2193 return Def;
2194 }
2195
2196 case Decl::UsingShadow:
2197 return clang_getCursorDefinition(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002198 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002199 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00002200
2201 case Decl::ObjCMethod: {
2202 ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
2203 if (Method->isThisDeclarationADefinition())
2204 return C;
2205
2206 // Dig out the method definition in the associated
2207 // @implementation, if we have it.
2208 // FIXME: The ASTs should make finding the definition easier.
2209 if (ObjCInterfaceDecl *Class
2210 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
2211 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
2212 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
2213 Method->isInstanceMethod()))
2214 if (Def->isThisDeclarationADefinition())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002215 return MakeCXCursor(Def, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002216
2217 return clang_getNullCursor();
2218 }
2219
2220 case Decl::ObjCCategory:
2221 if (ObjCCategoryImplDecl *Impl
2222 = cast<ObjCCategoryDecl>(D)->getImplementation())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002223 return MakeCXCursor(Impl, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002224 return clang_getNullCursor();
2225
2226 case Decl::ObjCProtocol:
2227 if (!cast<ObjCProtocolDecl>(D)->isForwardDecl())
2228 return C;
2229 return clang_getNullCursor();
2230
2231 case Decl::ObjCInterface:
2232 // There are two notions of a "definition" for an Objective-C
2233 // class: the interface and its implementation. When we resolved a
2234 // reference to an Objective-C class, produce the @interface as
2235 // the definition; when we were provided with the interface,
2236 // produce the @implementation as the definition.
2237 if (WasReference) {
2238 if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl())
2239 return C;
2240 } else if (ObjCImplementationDecl *Impl
2241 = cast<ObjCInterfaceDecl>(D)->getImplementation())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002242 return MakeCXCursor(Impl, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002243 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002244
Douglas Gregorb6998662010-01-19 19:34:47 +00002245 case Decl::ObjCProperty:
2246 // FIXME: We don't really know where to find the
2247 // ObjCPropertyImplDecls that implement this property.
2248 return clang_getNullCursor();
2249
2250 case Decl::ObjCCompatibleAlias:
2251 if (ObjCInterfaceDecl *Class
2252 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
2253 if (!Class->isForwardDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002254 return MakeCXCursor(Class, CXXUnit);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002255
Douglas Gregorb6998662010-01-19 19:34:47 +00002256 return clang_getNullCursor();
2257
2258 case Decl::ObjCForwardProtocol: {
2259 ObjCForwardProtocolDecl *Forward = cast<ObjCForwardProtocolDecl>(D);
2260 if (Forward->protocol_size() == 1)
2261 return clang_getCursorDefinition(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002262 MakeCXCursor(*Forward->protocol_begin(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002263 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00002264
2265 // FIXME: Cannot return multiple definitions.
2266 return clang_getNullCursor();
2267 }
2268
2269 case Decl::ObjCClass: {
2270 ObjCClassDecl *Class = cast<ObjCClassDecl>(D);
2271 if (Class->size() == 1) {
2272 ObjCInterfaceDecl *IFace = Class->begin()->getInterface();
2273 if (!IFace->isForwardDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002274 return MakeCXCursor(IFace, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00002275 return clang_getNullCursor();
2276 }
2277
2278 // FIXME: Cannot return multiple definitions.
2279 return clang_getNullCursor();
2280 }
2281
2282 case Decl::Friend:
2283 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002284 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00002285 return clang_getNullCursor();
2286
2287 case Decl::FriendTemplate:
2288 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002289 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00002290 return clang_getNullCursor();
2291 }
2292
2293 return clang_getNullCursor();
2294}
2295
2296unsigned clang_isCursorDefinition(CXCursor C) {
2297 if (!clang_isDeclaration(C.kind))
2298 return 0;
2299
2300 return clang_getCursorDefinition(C) == C;
2301}
2302
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002303void clang_getDefinitionSpellingAndExtent(CXCursor C,
Steve Naroff4ade6d62009-09-23 17:52:52 +00002304 const char **startBuf,
2305 const char **endBuf,
2306 unsigned *startLine,
2307 unsigned *startColumn,
2308 unsigned *endLine,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002309 unsigned *endColumn) {
Douglas Gregor283cae32010-01-15 21:56:13 +00002310 assert(getCursorDecl(C) && "CXCursor has null decl");
2311 NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C));
Steve Naroff4ade6d62009-09-23 17:52:52 +00002312 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
2313 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002314
Steve Naroff4ade6d62009-09-23 17:52:52 +00002315 SourceManager &SM = FD->getASTContext().getSourceManager();
2316 *startBuf = SM.getCharacterData(Body->getLBracLoc());
2317 *endBuf = SM.getCharacterData(Body->getRBracLoc());
2318 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
2319 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
2320 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
2321 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
2322}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002323
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002324void clang_enableStackTraces(void) {
2325 llvm::sys::PrintStackTraceOnErrorSignal();
2326}
2327
Ted Kremenekfb480492010-01-13 21:46:36 +00002328} // end: extern "C"
Steve Naroff4ade6d62009-09-23 17:52:52 +00002329
Ted Kremenekfb480492010-01-13 21:46:36 +00002330//===----------------------------------------------------------------------===//
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002331// Token-based Operations.
2332//===----------------------------------------------------------------------===//
2333
2334/* CXToken layout:
2335 * int_data[0]: a CXTokenKind
2336 * int_data[1]: starting token location
2337 * int_data[2]: token length
2338 * int_data[3]: reserved
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002339 * ptr_data: for identifiers and keywords, an IdentifierInfo*.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002340 * otherwise unused.
2341 */
2342extern "C" {
2343
2344CXTokenKind clang_getTokenKind(CXToken CXTok) {
2345 return static_cast<CXTokenKind>(CXTok.int_data[0]);
2346}
2347
2348CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
2349 switch (clang_getTokenKind(CXTok)) {
2350 case CXToken_Identifier:
2351 case CXToken_Keyword:
2352 // We know we have an IdentifierInfo*, so use that.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002353 return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data)
2354 ->getNameStart());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002355
2356 case CXToken_Literal: {
2357 // We have stashed the starting pointer in the ptr_data field. Use it.
2358 const char *Text = static_cast<const char *>(CXTok.ptr_data);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002359 return createCXString(llvm::StringRef(Text, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002360 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002361
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002362 case CXToken_Punctuation:
2363 case CXToken_Comment:
2364 break;
2365 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002366
2367 // We have to find the starting buffer pointer the hard way, by
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002368 // deconstructing the source location.
2369 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2370 if (!CXXUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002371 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002372
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002373 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
2374 std::pair<FileID, unsigned> LocInfo
2375 = CXXUnit->getSourceManager().getDecomposedLoc(Loc);
Douglas Gregorf715ca12010-03-16 00:06:06 +00002376 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002377 llvm::StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00002378 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
2379 if (Invalid)
Douglas Gregoraea67db2010-03-15 22:54:52 +00002380 return createCXString("");
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002381
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002382 return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002383}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002384
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002385CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
2386 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2387 if (!CXXUnit)
2388 return clang_getNullLocation();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002389
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002390 return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
2391 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
2392}
2393
2394CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
2395 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
Douglas Gregor5352ac02010-01-28 00:27:43 +00002396 if (!CXXUnit)
2397 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002398
2399 return cxloc::translateSourceRange(CXXUnit->getASTContext(),
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002400 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
2401}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002402
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002403void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
2404 CXToken **Tokens, unsigned *NumTokens) {
2405 if (Tokens)
2406 *Tokens = 0;
2407 if (NumTokens)
2408 *NumTokens = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002409
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002410 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2411 if (!CXXUnit || !Tokens || !NumTokens)
2412 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002413
Douglas Gregorbdf60622010-03-05 21:16:25 +00002414 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
2415
Daniel Dunbar85b988f2010-02-14 08:31:57 +00002416 SourceRange R = cxloc::translateCXSourceRange(Range);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002417 if (R.isInvalid())
2418 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002419
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002420 SourceManager &SourceMgr = CXXUnit->getSourceManager();
2421 std::pair<FileID, unsigned> BeginLocInfo
2422 = SourceMgr.getDecomposedLoc(R.getBegin());
2423 std::pair<FileID, unsigned> EndLocInfo
2424 = SourceMgr.getDecomposedLoc(R.getEnd());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002425
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002426 // Cannot tokenize across files.
2427 if (BeginLocInfo.first != EndLocInfo.first)
2428 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002429
2430 // Create a lexer
Douglas Gregorf715ca12010-03-16 00:06:06 +00002431 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002432 llvm::StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00002433 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
Douglas Gregor47a3fcd2010-03-16 20:26:15 +00002434 if (Invalid)
2435 return;
Douglas Gregoraea67db2010-03-15 22:54:52 +00002436
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002437 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
2438 CXXUnit->getASTContext().getLangOptions(),
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002439 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002440 Lex.SetCommentRetentionState(true);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002441
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002442 // Lex tokens until we hit the end of the range.
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002443 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002444 llvm::SmallVector<CXToken, 32> CXTokens;
2445 Token Tok;
2446 do {
2447 // Lex the next token
2448 Lex.LexFromRawLexer(Tok);
2449 if (Tok.is(tok::eof))
2450 break;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002451
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002452 // Initialize the CXToken.
2453 CXToken CXTok;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002454
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002455 // - Common fields
2456 CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
2457 CXTok.int_data[2] = Tok.getLength();
2458 CXTok.int_data[3] = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002459
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002460 // - Kind-specific fields
2461 if (Tok.isLiteral()) {
2462 CXTok.int_data[0] = CXToken_Literal;
2463 CXTok.ptr_data = (void *)Tok.getLiteralData();
2464 } else if (Tok.is(tok::identifier)) {
Douglas Gregoraea67db2010-03-15 22:54:52 +00002465 // Lookup the identifier to determine whether we have a keyword.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002466 std::pair<FileID, unsigned> LocInfo
2467 = SourceMgr.getDecomposedLoc(Tok.getLocation());
Douglas Gregorf715ca12010-03-16 00:06:06 +00002468 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002469 llvm::StringRef Buf
Douglas Gregorf715ca12010-03-16 00:06:06 +00002470 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
2471 if (Invalid)
Douglas Gregoraea67db2010-03-15 22:54:52 +00002472 return;
2473
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00002474 const char *StartPos = Buf.data() + LocInfo.second;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002475 IdentifierInfo *II
2476 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok, StartPos);
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00002477
2478 if (II->getObjCKeywordID() != tok::objc_not_keyword) {
2479 CXTok.int_data[0] = CXToken_Keyword;
2480 }
2481 else {
2482 CXTok.int_data[0] = II->getTokenID() == tok::identifier?
2483 CXToken_Identifier
2484 : CXToken_Keyword;
2485 }
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002486 CXTok.ptr_data = II;
2487 } else if (Tok.is(tok::comment)) {
2488 CXTok.int_data[0] = CXToken_Comment;
2489 CXTok.ptr_data = 0;
2490 } else {
2491 CXTok.int_data[0] = CXToken_Punctuation;
2492 CXTok.ptr_data = 0;
2493 }
2494 CXTokens.push_back(CXTok);
2495 } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002496
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002497 if (CXTokens.empty())
2498 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002499
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002500 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
2501 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
2502 *NumTokens = CXTokens.size();
2503}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002504
Ted Kremenek6db61092010-05-05 00:55:15 +00002505void clang_disposeTokens(CXTranslationUnit TU,
2506 CXToken *Tokens, unsigned NumTokens) {
2507 free(Tokens);
2508}
2509
2510} // end: extern "C"
2511
2512//===----------------------------------------------------------------------===//
2513// Token annotation APIs.
2514//===----------------------------------------------------------------------===//
2515
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002516typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002517static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
2518 CXCursor parent,
2519 CXClientData client_data);
Ted Kremenek6db61092010-05-05 00:55:15 +00002520namespace {
2521class AnnotateTokensWorker {
2522 AnnotateTokensData &Annotated;
Ted Kremenek11949cb2010-05-05 00:55:17 +00002523 CXToken *Tokens;
2524 CXCursor *Cursors;
2525 unsigned NumTokens;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002526 unsigned TokIdx;
2527 CursorVisitor AnnotateVis;
2528 SourceManager &SrcMgr;
2529
2530 bool MoreTokens() const { return TokIdx < NumTokens; }
2531 unsigned NextToken() const { return TokIdx; }
2532 void AdvanceToken() { ++TokIdx; }
2533 SourceLocation GetTokenLoc(unsigned tokI) {
2534 return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]);
2535 }
2536
Ted Kremenek6db61092010-05-05 00:55:15 +00002537public:
Ted Kremenek11949cb2010-05-05 00:55:17 +00002538 AnnotateTokensWorker(AnnotateTokensData &annotated,
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002539 CXToken *tokens, CXCursor *cursors, unsigned numTokens,
2540 ASTUnit *CXXUnit, SourceRange RegionOfInterest)
Ted Kremenek11949cb2010-05-05 00:55:17 +00002541 : Annotated(annotated), Tokens(tokens), Cursors(cursors),
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002542 NumTokens(numTokens), TokIdx(0),
2543 AnnotateVis(CXXUnit, AnnotateTokensVisitor, this,
2544 Decl::MaxPCHLevel, RegionOfInterest),
2545 SrcMgr(CXXUnit->getSourceManager()) {}
Ted Kremenek11949cb2010-05-05 00:55:17 +00002546
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002547 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
Ted Kremenek6db61092010-05-05 00:55:15 +00002548 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002549 void AnnotateTokens(CXCursor parent);
Ted Kremenek6db61092010-05-05 00:55:15 +00002550};
2551}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002552
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002553void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) {
2554 // Walk the AST within the region of interest, annotating tokens
2555 // along the way.
2556 VisitChildren(parent);
Ted Kremenek11949cb2010-05-05 00:55:17 +00002557
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002558 for (unsigned I = 0 ; I < TokIdx ; ++I) {
2559 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
2560 if (Pos != Annotated.end())
2561 Cursors[I] = Pos->second;
2562 }
2563
2564 // Finish up annotating any tokens left.
2565 if (!MoreTokens())
2566 return;
2567
2568 const CXCursor &C = clang_getNullCursor();
2569 for (unsigned I = TokIdx ; I < NumTokens ; ++I) {
2570 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
2571 Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second;
Ted Kremenek11949cb2010-05-05 00:55:17 +00002572 }
2573}
2574
Ted Kremenek6db61092010-05-05 00:55:15 +00002575enum CXChildVisitResult
2576AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002577 CXSourceLocation Loc = clang_getCursorLocation(cursor);
2578 // We can always annotate a preprocessing directive/macro instantiation.
2579 if (clang_isPreprocessing(cursor.kind)) {
2580 Annotated[Loc.int_data] = cursor;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002581 return CXChildVisit_Recurse;
2582 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002583
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002584 SourceRange cursorRange = getRawCursorExtent(cursor);
Ted Kremeneka333c662010-05-12 05:29:33 +00002585
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002586 if (cursorRange.isInvalid())
2587 return CXChildVisit_Continue;
Ted Kremeneka333c662010-05-12 05:29:33 +00002588
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002589 SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data);
2590
Ted Kremeneka333c662010-05-12 05:29:33 +00002591 // Adjust the annotated range based specific declarations.
2592 const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
2593 if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) {
Ted Kremenek23173d72010-05-18 21:09:07 +00002594 Decl *D = cxcursor::getCursorDecl(cursor);
2595 // Don't visit synthesized ObjC methods, since they have no syntatic
2596 // representation in the source.
2597 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
2598 if (MD->isSynthesized())
2599 return CXChildVisit_Continue;
2600 }
2601 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
Ted Kremeneka333c662010-05-12 05:29:33 +00002602 if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
2603 TypeLoc TL = TI->getTypeLoc();
Abramo Bagnarabd054db2010-05-20 10:00:11 +00002604 SourceLocation TLoc = TL.getSourceRange().getBegin();
Ted Kremenek6bfd5332010-05-13 15:38:38 +00002605 if (TLoc.isValid() &&
2606 SrcMgr.isBeforeInTranslationUnit(TLoc, L))
Ted Kremeneka333c662010-05-12 05:29:33 +00002607 cursorRange.setBegin(TLoc);
Ted Kremeneka333c662010-05-12 05:29:33 +00002608 }
2609 }
2610 }
2611
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002612 const enum CXCursorKind K = clang_getCursorKind(parent);
2613 const CXCursor updateC =
2614 (clang_isInvalid(K) || K == CXCursor_TranslationUnit ||
2615 L.isMacroID())
2616 ? clang_getNullCursor() : parent;
2617
2618 while (MoreTokens()) {
2619 const unsigned I = NextToken();
2620 SourceLocation TokLoc = GetTokenLoc(I);
2621 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
2622 case RangeBefore:
2623 Cursors[I] = updateC;
2624 AdvanceToken();
2625 continue;
2626 case RangeAfter:
2627 return CXChildVisit_Continue;
2628 case RangeOverlap:
2629 break;
2630 }
2631 break;
2632 }
2633
2634 // Visit children to get their cursor information.
2635 const unsigned BeforeChildren = NextToken();
2636 VisitChildren(cursor);
2637 const unsigned AfterChildren = NextToken();
2638
2639 // Adjust 'Last' to the last token within the extent of the cursor.
2640 while (MoreTokens()) {
2641 const unsigned I = NextToken();
2642 SourceLocation TokLoc = GetTokenLoc(I);
2643 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
2644 case RangeBefore:
2645 assert(0 && "Infeasible");
2646 case RangeAfter:
2647 break;
2648 case RangeOverlap:
2649 Cursors[I] = updateC;
2650 AdvanceToken();
2651 continue;
2652 }
2653 break;
2654 }
2655 const unsigned Last = NextToken();
Ted Kremenek6db61092010-05-05 00:55:15 +00002656
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002657 // Scan the tokens that are at the beginning of the cursor, but are not
2658 // capture by the child cursors.
2659
2660 // For AST elements within macros, rely on a post-annotate pass to
2661 // to correctly annotate the tokens with cursors. Otherwise we can
2662 // get confusing results of having tokens that map to cursors that really
2663 // are expanded by an instantiation.
2664 if (L.isMacroID())
2665 cursor = clang_getNullCursor();
2666
2667 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
2668 if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
2669 break;
2670 Cursors[I] = cursor;
2671 }
2672 // Scan the tokens that are at the end of the cursor, but are not captured
2673 // but the child cursors.
2674 for (unsigned I = AfterChildren; I != Last; ++I)
2675 Cursors[I] = cursor;
2676
2677 TokIdx = Last;
2678 return CXChildVisit_Continue;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002679}
2680
Ted Kremenek6db61092010-05-05 00:55:15 +00002681static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
2682 CXCursor parent,
2683 CXClientData client_data) {
2684 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
2685}
2686
2687extern "C" {
2688
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002689void clang_annotateTokens(CXTranslationUnit TU,
2690 CXToken *Tokens, unsigned NumTokens,
2691 CXCursor *Cursors) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002692
2693 if (NumTokens == 0 || !Tokens || !Cursors)
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002694 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002695
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002696 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002697 if (!CXXUnit) {
2698 // Any token we don't specifically annotate will have a NULL cursor.
2699 const CXCursor &C = clang_getNullCursor();
2700 for (unsigned I = 0; I != NumTokens; ++I)
2701 Cursors[I] = C;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002702 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002703 }
2704
Douglas Gregorbdf60622010-03-05 21:16:25 +00002705 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002706
Douglas Gregor0396f462010-03-19 05:22:59 +00002707 // Determine the region of interest, which contains all of the tokens.
Douglas Gregor0045e9f2010-01-26 18:31:56 +00002708 SourceRange RegionOfInterest;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002709 RegionOfInterest.setBegin(cxloc::translateSourceLocation(
2710 clang_getTokenLocation(TU, Tokens[0])));
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002711 RegionOfInterest.setEnd(cxloc::translateSourceLocation(
2712 clang_getTokenLocation(TU,
2713 Tokens[NumTokens - 1])));
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002714
Douglas Gregor0396f462010-03-19 05:22:59 +00002715 // A mapping from the source locations found when re-lexing or traversing the
2716 // region of interest to the corresponding cursors.
2717 AnnotateTokensData Annotated;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002718
2719 // Relex the tokens within the source range to look for preprocessing
Douglas Gregor0396f462010-03-19 05:22:59 +00002720 // directives.
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002721 SourceManager &SourceMgr = CXXUnit->getSourceManager();
2722 std::pair<FileID, unsigned> BeginLocInfo
2723 = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin());
2724 std::pair<FileID, unsigned> EndLocInfo
2725 = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd());
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002726
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002727 llvm::StringRef Buffer;
Douglas Gregor0396f462010-03-19 05:22:59 +00002728 bool Invalid = false;
2729 if (BeginLocInfo.first == EndLocInfo.first &&
2730 ((Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid)),true) &&
2731 !Invalid) {
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002732 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
2733 CXXUnit->getASTContext().getLangOptions(),
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002734 Buffer.begin(), Buffer.data() + BeginLocInfo.second,
Douglas Gregor4ae8f292010-03-18 17:52:52 +00002735 Buffer.end());
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002736 Lex.SetCommentRetentionState(true);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002737
2738 // Lex tokens in raw mode until we hit the end of the range, to avoid
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002739 // entering #includes or expanding macros.
Douglas Gregor48072312010-03-18 15:23:44 +00002740 while (true) {
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002741 Token Tok;
2742 Lex.LexFromRawLexer(Tok);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002743
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002744 reprocess:
2745 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
2746 // We have found a preprocessing directive. Gobble it up so that we
2747 // don't see it while preprocessing these tokens later, but keep track of
2748 // all of the token locations inside this preprocessing directive so that
2749 // we can annotate them appropriately.
2750 //
2751 // FIXME: Some simple tests here could identify macro definitions and
2752 // #undefs, to provide specific cursor kinds for those.
2753 std::vector<SourceLocation> Locations;
2754 do {
2755 Locations.push_back(Tok.getLocation());
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002756 Lex.LexFromRawLexer(Tok);
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002757 } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof));
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002758
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002759 using namespace cxcursor;
2760 CXCursor Cursor
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002761 = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(),
2762 Locations.back()),
Ted Kremenek6db61092010-05-05 00:55:15 +00002763 CXXUnit);
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002764 for (unsigned I = 0, N = Locations.size(); I != N; ++I) {
2765 Annotated[Locations[I].getRawEncoding()] = Cursor;
2766 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002767
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002768 if (Tok.isAtStartOfLine())
2769 goto reprocess;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002770
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002771 continue;
2772 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002773
Douglas Gregor48072312010-03-18 15:23:44 +00002774 if (Tok.is(tok::eof))
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002775 break;
2776 }
Douglas Gregor4ae8f292010-03-18 17:52:52 +00002777 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002778
Douglas Gregor0396f462010-03-19 05:22:59 +00002779 // Annotate all of the source locations in the region of interest that map to
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00002780 // a specific cursor.
2781 AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens,
2782 CXXUnit, RegionOfInterest);
2783 W.AnnotateTokens(clang_getTranslationUnitCursor(CXXUnit));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002784}
Douglas Gregorfc8ea232010-01-26 17:06:03 +00002785} // end: extern "C"
2786
2787//===----------------------------------------------------------------------===//
Ted Kremenek16b42592010-03-03 06:36:57 +00002788// Operations for querying linkage of a cursor.
2789//===----------------------------------------------------------------------===//
2790
2791extern "C" {
2792CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
Douglas Gregor0396f462010-03-19 05:22:59 +00002793 if (!clang_isDeclaration(cursor.kind))
2794 return CXLinkage_Invalid;
2795
Ted Kremenek16b42592010-03-03 06:36:57 +00002796 Decl *D = cxcursor::getCursorDecl(cursor);
2797 if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
2798 switch (ND->getLinkage()) {
2799 case NoLinkage: return CXLinkage_NoLinkage;
2800 case InternalLinkage: return CXLinkage_Internal;
2801 case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
2802 case ExternalLinkage: return CXLinkage_External;
2803 };
2804
2805 return CXLinkage_Invalid;
2806}
2807} // end: extern "C"
2808
2809//===----------------------------------------------------------------------===//
Ted Kremenek45e1dae2010-04-12 21:22:16 +00002810// Operations for querying language of a cursor.
2811//===----------------------------------------------------------------------===//
2812
2813static CXLanguageKind getDeclLanguage(const Decl *D) {
2814 switch (D->getKind()) {
2815 default:
2816 break;
2817 case Decl::ImplicitParam:
2818 case Decl::ObjCAtDefsField:
2819 case Decl::ObjCCategory:
2820 case Decl::ObjCCategoryImpl:
2821 case Decl::ObjCClass:
2822 case Decl::ObjCCompatibleAlias:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00002823 case Decl::ObjCForwardProtocol:
2824 case Decl::ObjCImplementation:
2825 case Decl::ObjCInterface:
2826 case Decl::ObjCIvar:
2827 case Decl::ObjCMethod:
2828 case Decl::ObjCProperty:
2829 case Decl::ObjCPropertyImpl:
2830 case Decl::ObjCProtocol:
2831 return CXLanguage_ObjC;
2832 case Decl::CXXConstructor:
2833 case Decl::CXXConversion:
2834 case Decl::CXXDestructor:
2835 case Decl::CXXMethod:
2836 case Decl::CXXRecord:
2837 case Decl::ClassTemplate:
2838 case Decl::ClassTemplatePartialSpecialization:
2839 case Decl::ClassTemplateSpecialization:
2840 case Decl::Friend:
2841 case Decl::FriendTemplate:
2842 case Decl::FunctionTemplate:
2843 case Decl::LinkageSpec:
2844 case Decl::Namespace:
2845 case Decl::NamespaceAlias:
2846 case Decl::NonTypeTemplateParm:
2847 case Decl::StaticAssert:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00002848 case Decl::TemplateTemplateParm:
2849 case Decl::TemplateTypeParm:
2850 case Decl::UnresolvedUsingTypename:
2851 case Decl::UnresolvedUsingValue:
2852 case Decl::Using:
2853 case Decl::UsingDirective:
2854 case Decl::UsingShadow:
2855 return CXLanguage_CPlusPlus;
2856 }
2857
2858 return CXLanguage_C;
2859}
2860
2861extern "C" {
2862CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
2863 if (clang_isDeclaration(cursor.kind))
2864 return getDeclLanguage(cxcursor::getCursorDecl(cursor));
2865
2866 return CXLanguage_Invalid;
2867}
2868} // end: extern "C"
2869
Ted Kremenek9ada39a2010-05-17 20:06:56 +00002870
2871//===----------------------------------------------------------------------===//
2872// C++ AST instrospection.
2873//===----------------------------------------------------------------------===//
2874
2875extern "C" {
2876unsigned clang_CXXMethod_isStatic(CXCursor C) {
2877 if (!clang_isDeclaration(C.kind))
2878 return 0;
2879 CXXMethodDecl *D = dyn_cast<CXXMethodDecl>(cxcursor::getCursorDecl(C));
2880 return (D && D->isStatic()) ? 1 : 0;
Ted Kremenek40b492a2010-05-17 20:12:45 +00002881}
Ted Kremenekb12903e2010-05-18 22:32:15 +00002882
Ted Kremenek9ada39a2010-05-17 20:06:56 +00002883} // end: extern "C"
2884
Ted Kremenek45e1dae2010-04-12 21:22:16 +00002885//===----------------------------------------------------------------------===//
Ted Kremenekfb480492010-01-13 21:46:36 +00002886// CXString Operations.
2887//===----------------------------------------------------------------------===//
2888
2889extern "C" {
2890const char *clang_getCString(CXString string) {
2891 return string.Spelling;
2892}
2893
2894void clang_disposeString(CXString string) {
2895 if (string.MustFreeString && string.Spelling)
2896 free((void*)string.Spelling);
2897}
Ted Kremenek04bb7162010-01-22 22:44:15 +00002898
Ted Kremenekfb480492010-01-13 21:46:36 +00002899} // end: extern "C"
Ted Kremenek04bb7162010-01-22 22:44:15 +00002900
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002901namespace clang { namespace cxstring {
2902CXString createCXString(const char *String, bool DupString){
2903 CXString Str;
2904 if (DupString) {
2905 Str.Spelling = strdup(String);
2906 Str.MustFreeString = 1;
2907 } else {
2908 Str.Spelling = String;
2909 Str.MustFreeString = 0;
2910 }
2911 return Str;
2912}
2913
2914CXString createCXString(llvm::StringRef String, bool DupString) {
2915 CXString Result;
2916 if (DupString || (!String.empty() && String.data()[String.size()] != 0)) {
2917 char *Spelling = (char *)malloc(String.size() + 1);
2918 memmove(Spelling, String.data(), String.size());
2919 Spelling[String.size()] = 0;
2920 Result.Spelling = Spelling;
2921 Result.MustFreeString = 1;
2922 } else {
2923 Result.Spelling = String.data();
2924 Result.MustFreeString = 0;
2925 }
2926 return Result;
2927}
2928}}
2929
Ted Kremenek04bb7162010-01-22 22:44:15 +00002930//===----------------------------------------------------------------------===//
2931// Misc. utility functions.
2932//===----------------------------------------------------------------------===//
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002933
Ted Kremenek04bb7162010-01-22 22:44:15 +00002934extern "C" {
2935
Ted Kremeneka2a9d6e2010-02-12 22:54:40 +00002936CXString clang_getClangVersion() {
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002937 return createCXString(getClangFullVersion());
Ted Kremenek04bb7162010-01-22 22:44:15 +00002938}
2939
2940} // end: extern "C"