blob: 070cb18d77934ce79ac0a67c86d3fa9354debedd [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 Kremenekab188932010-01-05 19:32:54 +000017
Steve Naroff50398192009-08-28 15:28:48 +000018#include "clang/AST/DeclVisitor.h"
Steve Narofffb570422009-09-22 19:25:29 +000019#include "clang/AST/StmtVisitor.h"
Douglas Gregor7d0d40e2010-01-21 16:28:34 +000020#include "clang/AST/TypeLocVisitor.h"
Ted Kremenekd8210652010-01-06 23:43:31 +000021#include "clang/Lex/Lexer.h"
Douglas Gregor02465752009-10-16 21:24:31 +000022#include "llvm/Support/MemoryBuffer.h"
Benjamin Kramer0829a832009-10-18 11:19:36 +000023#include "llvm/System/Program.h"
Ted Kremenekfc062212009-10-19 21:44:57 +000024
Ted Kremenekdb3d0da2010-01-05 20:55:39 +000025// Needed to define L_TMPNAM on some systems.
26#include <cstdio>
27
Steve Naroff50398192009-08-28 15:28:48 +000028using namespace clang;
Ted Kremenek16c440a2010-01-15 20:35:54 +000029using namespace clang::cxcursor;
Steve Naroff50398192009-08-28 15:28:48 +000030using namespace idx;
31
Ted Kremenek8a8da7d2010-01-06 03:42:32 +000032//===----------------------------------------------------------------------===//
33// Crash Reporting.
34//===----------------------------------------------------------------------===//
35
36#ifdef __APPLE__
Ted Kremenek29b72842010-01-07 22:49:05 +000037#ifndef NDEBUG
38#define USE_CRASHTRACER
Ted Kremenek8a8da7d2010-01-06 03:42:32 +000039#include "clang/Analysis/Support/SaveAndRestore.h"
40// Integrate with crash reporter.
41extern "C" const char *__crashreporter_info__;
Ted Kremenek29b72842010-01-07 22:49:05 +000042#define NUM_CRASH_STRINGS 16
43static unsigned crashtracer_counter = 0;
Ted Kremenek254ba7c2010-01-07 23:13:53 +000044static unsigned crashtracer_counter_id[NUM_CRASH_STRINGS] = { 0 };
Ted Kremenek29b72842010-01-07 22:49:05 +000045static const char *crashtracer_strings[NUM_CRASH_STRINGS] = { 0 };
46static const char *agg_crashtracer_strings[NUM_CRASH_STRINGS] = { 0 };
47
48static unsigned SetCrashTracerInfo(const char *str,
49 llvm::SmallString<1024> &AggStr) {
50
Ted Kremenek254ba7c2010-01-07 23:13:53 +000051 unsigned slot = 0;
Ted Kremenek29b72842010-01-07 22:49:05 +000052 while (crashtracer_strings[slot]) {
53 if (++slot == NUM_CRASH_STRINGS)
54 slot = 0;
55 }
56 crashtracer_strings[slot] = str;
Ted Kremenek254ba7c2010-01-07 23:13:53 +000057 crashtracer_counter_id[slot] = ++crashtracer_counter;
Ted Kremenek29b72842010-01-07 22:49:05 +000058
59 // We need to create an aggregate string because multiple threads
60 // may be in this method at one time. The crash reporter string
61 // will attempt to overapproximate the set of in-flight invocations
62 // of this function. Race conditions can still cause this goal
63 // to not be achieved.
64 {
65 llvm::raw_svector_ostream Out(AggStr);
66 for (unsigned i = 0; i < NUM_CRASH_STRINGS; ++i)
67 if (crashtracer_strings[i]) Out << crashtracer_strings[i] << '\n';
68 }
69 __crashreporter_info__ = agg_crashtracer_strings[slot] = AggStr.c_str();
70 return slot;
71}
72
73static void ResetCrashTracerInfo(unsigned slot) {
Ted Kremenek254ba7c2010-01-07 23:13:53 +000074 unsigned max_slot = 0;
75 unsigned max_value = 0;
76
77 crashtracer_strings[slot] = agg_crashtracer_strings[slot] = 0;
78
79 for (unsigned i = 0 ; i < NUM_CRASH_STRINGS; ++i)
80 if (agg_crashtracer_strings[i] &&
81 crashtracer_counter_id[i] > max_value) {
82 max_slot = i;
83 max_value = crashtracer_counter_id[i];
Ted Kremenek29b72842010-01-07 22:49:05 +000084 }
Ted Kremenek254ba7c2010-01-07 23:13:53 +000085
86 __crashreporter_info__ = agg_crashtracer_strings[max_slot];
Ted Kremenek29b72842010-01-07 22:49:05 +000087}
88
89namespace {
90class ArgsCrashTracerInfo {
91 llvm::SmallString<1024> CrashString;
92 llvm::SmallString<1024> AggregateString;
93 unsigned crashtracerSlot;
94public:
95 ArgsCrashTracerInfo(llvm::SmallVectorImpl<const char*> &Args)
96 : crashtracerSlot(0)
97 {
98 {
99 llvm::raw_svector_ostream Out(CrashString);
100 Out << "ClangCIndex [createTranslationUnitFromSourceFile]: clang";
101 for (llvm::SmallVectorImpl<const char*>::iterator I=Args.begin(),
102 E=Args.end(); I!=E; ++I)
103 Out << ' ' << *I;
104 }
105 crashtracerSlot = SetCrashTracerInfo(CrashString.c_str(),
106 AggregateString);
107 }
108
109 ~ArgsCrashTracerInfo() {
110 ResetCrashTracerInfo(crashtracerSlot);
111 }
112};
113}
114#endif
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000115#endif
116
Douglas Gregor1db19de2010-01-19 21:36:55 +0000117typedef llvm::PointerIntPair<ASTContext *, 1, bool> CXSourceLocationPtr;
118
Douglas Gregor98258af2010-01-18 22:46:11 +0000119/// \brief Translate a Clang source location into a CIndex source location.
Douglas Gregor1db19de2010-01-19 21:36:55 +0000120static CXSourceLocation translateSourceLocation(ASTContext &Context,
121 SourceLocation Loc,
122 bool AtEnd = false) {
123 CXSourceLocationPtr Ptr(&Context, AtEnd);
124 CXSourceLocation Result = { Ptr.getOpaqueValue(), Loc.getRawEncoding() };
125 return Result;
Douglas Gregor98258af2010-01-18 22:46:11 +0000126}
127
Douglas Gregora7bde202010-01-19 00:34:46 +0000128/// \brief Translate a Clang source range into a CIndex source range.
Douglas Gregor1db19de2010-01-19 21:36:55 +0000129static CXSourceRange translateSourceRange(ASTContext &Context, SourceRange R) {
130 CXSourceRange Result = { &Context,
131 R.getBegin().getRawEncoding(),
132 R.getEnd().getRawEncoding() };
133 return Result;
Douglas Gregora7bde202010-01-19 00:34:46 +0000134}
135
Douglas Gregor1db19de2010-01-19 21:36:55 +0000136
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000137//===----------------------------------------------------------------------===//
138// Visitors.
139//===----------------------------------------------------------------------===//
140
Steve Naroff89922f82009-08-31 00:59:03 +0000141namespace {
Ted Kremenekedc8aa62010-01-16 00:36:30 +0000142
Douglas Gregorb1373d02010-01-20 20:59:29 +0000143// Cursor visitor.
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000144class CursorVisitor : public DeclVisitor<CursorVisitor, bool>,
145 public TypeLocVisitor<CursorVisitor, bool>
146{
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000147 ASTUnit *TU;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000148 CXCursor Parent;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000149 Decl *StmtParent;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000150 CXCursorVisitor Visitor;
151 CXClientData ClientData;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000152
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000153 // MaxPCHLevel - the maximum PCH level of declarations that we will pass on
154 // to the visitor. Declarations with a PCH level greater than this value will
155 // be suppressed.
156 unsigned MaxPCHLevel;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000157
158 using DeclVisitor<CursorVisitor, bool>::Visit;
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000159 using TypeLocVisitor<CursorVisitor, bool>::Visit;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000160
Steve Naroff89922f82009-08-31 00:59:03 +0000161public:
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000162 CursorVisitor(ASTUnit *TU, CXCursorVisitor Visitor, CXClientData ClientData,
Douglas Gregorb1373d02010-01-20 20:59:29 +0000163 unsigned MaxPCHLevel)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000164 : TU(TU), Visitor(Visitor), ClientData(ClientData), MaxPCHLevel(MaxPCHLevel)
Douglas Gregorb1373d02010-01-20 20:59:29 +0000165 {
166 Parent.kind = CXCursor_NoDeclFound;
167 Parent.data[0] = 0;
168 Parent.data[1] = 0;
169 Parent.data[2] = 0;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000170 StmtParent = 0;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000171 }
172
173 bool Visit(CXCursor Cursor);
174 bool VisitChildren(CXCursor Parent);
175
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000176 // Declaration visitors
Douglas Gregorb1373d02010-01-20 20:59:29 +0000177 bool VisitDeclContext(DeclContext *DC);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000178 bool VisitTranslationUnitDecl(TranslationUnitDecl *D);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000179 bool VisitDeclaratorDecl(DeclaratorDecl *DD);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000180 bool VisitFunctionDecl(FunctionDecl *ND);
181 bool VisitObjCCategoryDecl(ObjCCategoryDecl *ND);
182 bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
183 bool VisitObjCMethodDecl(ObjCMethodDecl *ND);
184 bool VisitObjCProtocolDecl(ObjCProtocolDecl *PID);
185 bool VisitTagDecl(TagDecl *D);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000186
187 // Type visitors
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000188 // FIXME: QualifiedTypeLoc doesn't provide any location information
189 bool VisitBuiltinTypeLoc(BuiltinTypeLoc TL);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000190 bool VisitTypedefTypeLoc(TypedefTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000191 bool VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL);
192 bool VisitTagTypeLoc(TagTypeLoc TL);
193 // FIXME: TemplateTypeParmTypeLoc doesn't provide any location information
194 bool VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL);
195 bool VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL);
196 bool VisitPointerTypeLoc(PointerTypeLoc TL);
197 bool VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL);
198 bool VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL);
199 bool VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL);
200 bool VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL);
201 bool VisitFunctionTypeLoc(FunctionTypeLoc TL);
202 bool VisitArrayTypeLoc(ArrayTypeLoc TL);
Douglas Gregor2332c112010-01-21 20:48:56 +0000203 // FIXME: Implement for TemplateSpecializationTypeLoc
204 // FIXME: Implement visitors here when the unimplemented TypeLocs get
205 // implemented
206 bool VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL);
207 bool VisitTypeOfTypeLoc(TypeOfTypeLoc TL);
Steve Naroff89922f82009-08-31 00:59:03 +0000208};
Douglas Gregorb1373d02010-01-20 20:59:29 +0000209
Ted Kremenekab188932010-01-05 19:32:54 +0000210} // end anonymous namespace
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000211
Douglas Gregorb1373d02010-01-20 20:59:29 +0000212/// \brief Visit the given cursor and, if requested by the visitor,
213/// its children.
214///
215/// \returns true if the visitation should be aborted, false if it
216/// should continue.
217bool CursorVisitor::Visit(CXCursor Cursor) {
218 if (clang_isInvalid(Cursor.kind))
219 return false;
220
221 if (clang_isDeclaration(Cursor.kind)) {
222 Decl *D = getCursorDecl(Cursor);
223 assert(D && "Invalid declaration cursor");
224 if (D->getPCHLevel() > MaxPCHLevel)
225 return false;
226
227 if (D->isImplicit())
228 return false;
229 }
230
231 switch (Visitor(Cursor, Parent, ClientData)) {
232 case CXChildVisit_Break:
233 return true;
234
235 case CXChildVisit_Continue:
236 return false;
237
238 case CXChildVisit_Recurse:
239 return VisitChildren(Cursor);
240 }
241
242 llvm_unreachable("Silly GCC, we can't get here");
243}
244
245/// \brief Visit the children of the given cursor.
246///
247/// \returns true if the visitation should be aborted, false if it
248/// should continue.
249bool CursorVisitor::VisitChildren(CXCursor Cursor) {
250 // Set the Parent field to Cursor, then back to its old value once we're
251 // done.
252 class SetParentRAII {
253 CXCursor &Parent;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000254 Decl *&StmtParent;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000255 CXCursor OldParent;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000256
Douglas Gregorb1373d02010-01-20 20:59:29 +0000257 public:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000258 SetParentRAII(CXCursor &Parent, Decl *&StmtParent, CXCursor NewParent)
259 : Parent(Parent), StmtParent(StmtParent), OldParent(Parent)
Douglas Gregorb1373d02010-01-20 20:59:29 +0000260 {
261 Parent = NewParent;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000262 if (clang_isDeclaration(Parent.kind))
263 StmtParent = getCursorDecl(Parent);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000264 }
265
266 ~SetParentRAII() {
267 Parent = OldParent;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000268 if (clang_isDeclaration(Parent.kind))
269 StmtParent = getCursorDecl(Parent);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000270 }
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000271 } SetParent(Parent, StmtParent, Cursor);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000272
273 if (clang_isDeclaration(Cursor.kind)) {
274 Decl *D = getCursorDecl(Cursor);
275 assert(D && "Invalid declaration cursor");
276 return Visit(D);
277 }
278
279 if (clang_isTranslationUnit(Cursor.kind)) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000280 ASTUnit *CXXUnit = getCursorASTUnit(Cursor);
Douglas Gregor7b691f332010-01-20 21:13:59 +0000281 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls()) {
282 const std::vector<Decl*> &TLDs = CXXUnit->getTopLevelDecls();
283 for (std::vector<Decl*>::const_iterator it = TLDs.begin(),
284 ie = TLDs.end(); it != ie; ++it) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000285 if (Visit(MakeCXCursor(*it, CXXUnit)))
Douglas Gregor7b691f332010-01-20 21:13:59 +0000286 return true;
287 }
288 } else {
289 return VisitDeclContext(
Douglas Gregorb1373d02010-01-20 20:59:29 +0000290 CXXUnit->getASTContext().getTranslationUnitDecl());
Douglas Gregor7b691f332010-01-20 21:13:59 +0000291 }
292
293 return false;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000294 }
295
296 // Nothing to visit at the moment.
297 // FIXME: Traverse statements, declarations, etc. here.
298 return false;
299}
300
301bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
Douglas Gregor7b691f332010-01-20 21:13:59 +0000302 llvm_unreachable("Translation units are visited directly by Visit()");
303 return false;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000304}
305
306bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000307 for (DeclContext::decl_iterator
Douglas Gregorb1373d02010-01-20 20:59:29 +0000308 I = DC->decls_begin(), E = DC->decls_end(); I != E; ++I) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000309 if (Visit(MakeCXCursor(*I, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000310 return true;
311 }
312
313 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000314}
315
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000316bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
317 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
318 if (Visit(TSInfo->getTypeLoc()))
319 return true;
320
321 return false;
322}
323
Douglas Gregorb1373d02010-01-20 20:59:29 +0000324bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000325 if (VisitDeclaratorDecl(ND))
326 return true;
327
328 // FIXME: This is wrong. We want to visit the body as a statement.
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000329 if (ND->isThisDeclarationADefinition()) {
Douglas Gregorb1373d02010-01-20 20:59:29 +0000330 return VisitDeclContext(ND);
331
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000332#if 0
333 // Not currently needed.
334 CompoundStmt *Body = dyn_cast<CompoundStmt>(ND->getBody());
335 CRefVisitor RVisit(CDecl, Callback, CData);
336 RVisit.Visit(Body);
337#endif
338 }
Douglas Gregorb1373d02010-01-20 20:59:29 +0000339
340 return false;
341}
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000342
Douglas Gregorb1373d02010-01-20 20:59:29 +0000343bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000344 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
345 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000346 return true;
347
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000348 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
349 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
350 E = ND->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000351 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000352 return true;
353
354 return VisitDeclContext(ND);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000355}
356
Douglas Gregorb1373d02010-01-20 20:59:29 +0000357bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000358 // Issue callbacks for super class.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000359 if (D->getSuperClass() &&
360 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000361 D->getSuperClassLoc(),
362 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000363 return true;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000364
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000365 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
366 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
367 E = D->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000368 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000369 return true;
370
371 return VisitDeclContext(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000372}
373
Douglas Gregorb1373d02010-01-20 20:59:29 +0000374bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
375 // FIXME: Wrong in the same way that VisitFunctionDecl is wrong.
Douglas Gregorb6998662010-01-19 19:34:47 +0000376 if (ND->getBody())
Douglas Gregorb1373d02010-01-20 20:59:29 +0000377 return VisitDeclContext(ND);
378
379 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000380}
381
Douglas Gregorb1373d02010-01-20 20:59:29 +0000382bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000383 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000384 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000385 E = PID->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000386 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000387 return true;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000388
Douglas Gregorb1373d02010-01-20 20:59:29 +0000389 return VisitDeclContext(PID);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000390}
391
Douglas Gregorb1373d02010-01-20 20:59:29 +0000392bool CursorVisitor::VisitTagDecl(TagDecl *D) {
393 return VisitDeclContext(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000394}
395
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000396bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
397 ASTContext &Context = TU->getASTContext();
398
399 // Some builtin types (such as Objective-C's "id", "sel", and
400 // "Class") have associated declarations. Create cursors for those.
401 QualType VisitType;
402 switch (TL.getType()->getAs<BuiltinType>()->getKind()) {
403 case BuiltinType::Void:
404 case BuiltinType::Bool:
405 case BuiltinType::Char_U:
406 case BuiltinType::UChar:
407 case BuiltinType::Char16:
408 case BuiltinType::Char32:
409 case BuiltinType::UShort:
410 case BuiltinType::UInt:
411 case BuiltinType::ULong:
412 case BuiltinType::ULongLong:
413 case BuiltinType::UInt128:
414 case BuiltinType::Char_S:
415 case BuiltinType::SChar:
416 case BuiltinType::WChar:
417 case BuiltinType::Short:
418 case BuiltinType::Int:
419 case BuiltinType::Long:
420 case BuiltinType::LongLong:
421 case BuiltinType::Int128:
422 case BuiltinType::Float:
423 case BuiltinType::Double:
424 case BuiltinType::LongDouble:
425 case BuiltinType::NullPtr:
426 case BuiltinType::Overload:
427 case BuiltinType::Dependent:
428 break;
429
430 case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor?
431 break;
432
433 case BuiltinType::ObjCId:
434 VisitType = Context.getObjCIdType();
435 break;
436
437 case BuiltinType::ObjCClass:
438 VisitType = Context.getObjCClassType();
439 break;
440
441 case BuiltinType::ObjCSel:
442 VisitType = Context.getObjCSelType();
443 break;
444 }
445
446 if (!VisitType.isNull()) {
447 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
448 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
449 TU));
450 }
451
452 return false;
453}
454
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000455bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
456 return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU));
457}
458
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000459bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
460 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
461}
462
463bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
464 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
465}
466
467bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
468 if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU)))
469 return true;
470
471 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
472 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
473 TU)))
474 return true;
475 }
476
477 return false;
478}
479
480bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
481 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseTypeLoc()))
482 return true;
483
484 if (TL.hasProtocolsAsWritten()) {
485 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
486 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I),
487 TL.getProtocolLoc(I),
488 TU)))
489 return true;
490 }
491 }
492
493 return false;
494}
495
496bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
497 return Visit(TL.getPointeeLoc());
498}
499
500bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
501 return Visit(TL.getPointeeLoc());
502}
503
504bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
505 return Visit(TL.getPointeeLoc());
506}
507
508bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
509 return Visit(TL.getPointeeLoc());
510}
511
512bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
513 return Visit(TL.getPointeeLoc());
514}
515
516bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
517 if (Visit(TL.getResultLoc()))
518 return true;
519
520 // FIXME: For function definitions, this means that we'll end up
521 // visiting the parameters twice, because VisitFunctionDecl is
522 // walking the DeclContext.
523 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
524 if (Visit(MakeCXCursor(TL.getArg(I), TU)))
525 return true;
526
527 return false;
528}
529
530bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
531 if (Visit(TL.getElementLoc()))
532 return true;
533
534 if (Expr *Size = TL.getSizeExpr())
535 return Visit(MakeCXCursor(Size, StmtParent, TU));
536
537 return false;
538}
539
Douglas Gregor2332c112010-01-21 20:48:56 +0000540bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
541 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
542}
543
544bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
545 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
546 return Visit(TSInfo->getTypeLoc());
547
548 return false;
549}
550
Daniel Dunbar140fce22010-01-12 02:34:07 +0000551CXString CIndexer::createCXString(const char *String, bool DupString){
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000552 CXString Str;
553 if (DupString) {
554 Str.Spelling = strdup(String);
555 Str.MustFreeString = 1;
556 } else {
557 Str.Spelling = String;
558 Str.MustFreeString = 0;
559 }
560 return Str;
561}
562
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000563extern "C" {
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000564CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000565 int displayDiagnostics) {
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000566 CIndexer *CIdxr = new CIndexer(new Program());
567 if (excludeDeclarationsFromPCH)
568 CIdxr->setOnlyLocalDecls();
569 if (displayDiagnostics)
570 CIdxr->setDisplayDiagnostics();
571 return CIdxr;
Steve Naroff600866c2009-08-27 19:51:58 +0000572}
573
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000574void clang_disposeIndex(CXIndex CIdx) {
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000575 assert(CIdx && "Passed null CXIndex");
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000576 delete static_cast<CIndexer *>(CIdx);
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000577}
578
Daniel Dunbar8506dde2009-12-03 01:54:28 +0000579void clang_setUseExternalASTGeneration(CXIndex CIdx, int value) {
580 assert(CIdx && "Passed null CXIndex");
581 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
582 CXXIdx->setUseExternalASTGeneration(value);
583}
584
Steve Naroff50398192009-08-28 15:28:48 +0000585// FIXME: need to pass back error info.
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000586CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
587 const char *ast_filename) {
Steve Naroff50398192009-08-28 15:28:48 +0000588 assert(CIdx && "Passed null CXIndex");
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000589 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000590
Daniel Dunbar5262fda2009-12-03 01:45:44 +0000591 return ASTUnit::LoadFromPCHFile(ast_filename, CXXIdx->getDiags(),
592 CXXIdx->getOnlyLocalDecls(),
593 /* UseBumpAllocator = */ true);
Steve Naroff600866c2009-08-27 19:51:58 +0000594}
595
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000596CXTranslationUnit
597clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
598 const char *source_filename,
599 int num_command_line_args,
600 const char **command_line_args) {
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000601 assert(CIdx && "Passed null CXIndex");
602 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
603
Daniel Dunbar8506dde2009-12-03 01:54:28 +0000604 if (!CXXIdx->getUseExternalASTGeneration()) {
605 llvm::SmallVector<const char *, 16> Args;
606
607 // The 'source_filename' argument is optional. If the caller does not
608 // specify it then it is assumed that the source file is specified
609 // in the actual argument list.
610 if (source_filename)
611 Args.push_back(source_filename);
612 Args.insert(Args.end(), command_line_args,
613 command_line_args + num_command_line_args);
614
Daniel Dunbar94220972009-12-05 02:17:18 +0000615 unsigned NumErrors = CXXIdx->getDiags().getNumErrors();
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000616
Ted Kremenek29b72842010-01-07 22:49:05 +0000617#ifdef USE_CRASHTRACER
618 ArgsCrashTracerInfo ACTI(Args);
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000619#endif
620
Daniel Dunbar94220972009-12-05 02:17:18 +0000621 llvm::OwningPtr<ASTUnit> Unit(
622 ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(),
Daniel Dunbar869824e2009-12-13 03:46:13 +0000623 CXXIdx->getDiags(),
624 CXXIdx->getClangResourcesPath(),
Daniel Dunbar94220972009-12-05 02:17:18 +0000625 CXXIdx->getOnlyLocalDecls(),
626 /* UseBumpAllocator = */ true));
Ted Kremenek29b72842010-01-07 22:49:05 +0000627
Daniel Dunbar94220972009-12-05 02:17:18 +0000628 // FIXME: Until we have broader testing, just drop the entire AST if we
629 // encountered an error.
630 if (NumErrors != CXXIdx->getDiags().getNumErrors())
631 return 0;
632
633 return Unit.take();
Daniel Dunbar8506dde2009-12-03 01:54:28 +0000634 }
635
Ted Kremenek139ba862009-10-22 00:03:57 +0000636 // Build up the arguments for invoking 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000637 std::vector<const char *> argv;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000638
Ted Kremenek139ba862009-10-22 00:03:57 +0000639 // First add the complete path to the 'clang' executable.
640 llvm::sys::Path ClangPath = static_cast<CIndexer *>(CIdx)->getClangPath();
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000641 argv.push_back(ClangPath.c_str());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000642
Ted Kremenek139ba862009-10-22 00:03:57 +0000643 // Add the '-emit-ast' option as our execution mode for 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000644 argv.push_back("-emit-ast");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000645
Ted Kremenek139ba862009-10-22 00:03:57 +0000646 // The 'source_filename' argument is optional. If the caller does not
647 // specify it then it is assumed that the source file is specified
648 // in the actual argument list.
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000649 if (source_filename)
650 argv.push_back(source_filename);
Ted Kremenek139ba862009-10-22 00:03:57 +0000651
Steve Naroff37b5ac22009-10-15 20:50:09 +0000652 // Generate a temporary name for the AST file.
Ted Kremenek139ba862009-10-22 00:03:57 +0000653 argv.push_back("-o");
Steve Naroff37b5ac22009-10-15 20:50:09 +0000654 char astTmpFile[L_tmpnam];
Ted Kremenek74cd0692009-10-15 23:21:22 +0000655 argv.push_back(tmpnam(astTmpFile));
Ted Kremenek139ba862009-10-22 00:03:57 +0000656
657 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
658 for (int i = 0; i < num_command_line_args; ++i)
659 if (const char *arg = command_line_args[i]) {
660 if (strcmp(arg, "-o") == 0) {
661 ++i; // Also skip the matching argument.
662 continue;
663 }
664 if (strcmp(arg, "-emit-ast") == 0 ||
665 strcmp(arg, "-c") == 0 ||
666 strcmp(arg, "-fsyntax-only") == 0) {
667 continue;
668 }
669
670 // Keep the argument.
671 argv.push_back(arg);
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000672 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000673
Ted Kremenek139ba862009-10-22 00:03:57 +0000674 // Add the null terminator.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000675 argv.push_back(NULL);
676
Ted Kremenekfeb15e32009-10-26 22:14:08 +0000677 // Invoke 'clang'.
678 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
679 // on Unix or NUL (Windows).
Ted Kremenek379afec2009-10-22 03:24:01 +0000680 std::string ErrMsg;
Ted Kremenekc46e4632009-10-19 22:27:32 +0000681 const llvm::sys::Path *Redirects[] = { &DevNull, &DevNull, &DevNull, NULL };
Ted Kremenek379afec2009-10-22 03:24:01 +0000682 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
683 /* redirects */ !CXXIdx->getDisplayDiagnostics() ? &Redirects[0] : NULL,
684 /* secondsToWait */ 0, /* memoryLimits */ 0, &ErrMsg);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000685
Ted Kremenek0854d702009-11-10 19:18:52 +0000686 if (CXXIdx->getDisplayDiagnostics() && !ErrMsg.empty()) {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000687 llvm::errs() << "clang_createTranslationUnitFromSourceFile: " << ErrMsg
Daniel Dunbaracca7252009-11-30 20:42:49 +0000688 << '\n' << "Arguments: \n";
Ted Kremenek379afec2009-10-22 03:24:01 +0000689 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
Ted Kremenek779e5f42009-10-26 22:08:39 +0000690 I!=E; ++I) {
691 if (*I)
692 llvm::errs() << ' ' << *I << '\n';
693 }
694 llvm::errs() << '\n';
Ted Kremenek379afec2009-10-22 03:24:01 +0000695 }
Benjamin Kramer0829a832009-10-18 11:19:36 +0000696
Steve Naroff37b5ac22009-10-15 20:50:09 +0000697 // Finally, we create the translation unit from the ast file.
Steve Naroffe19944c2009-10-15 22:23:48 +0000698 ASTUnit *ATU = static_cast<ASTUnit *>(
Daniel Dunbaracca7252009-11-30 20:42:49 +0000699 clang_createTranslationUnit(CIdx, astTmpFile));
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000700 if (ATU)
701 ATU->unlinkTemporaryFile();
Steve Naroffe19944c2009-10-15 22:23:48 +0000702 return ATU;
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000703}
704
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000705void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000706 assert(CTUnit && "Passed null CXTranslationUnit");
707 delete static_cast<ASTUnit *>(CTUnit);
708}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000709
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000710CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000711 assert(CTUnit && "Passed null CXTranslationUnit");
Steve Naroff77accc12009-09-03 18:19:54 +0000712 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
Ted Kremenek4b333d22010-01-12 00:36:38 +0000713 return CIndexer::createCXString(CXXUnit->getOriginalSourceFileName().c_str(),
714 true);
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000715}
Daniel Dunbar1eb79b52009-08-28 16:30:07 +0000716
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +0000717CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000718 CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } };
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +0000719 return Result;
720}
721
Ted Kremenekfb480492010-01-13 21:46:36 +0000722} // end: extern "C"
Steve Naroff600866c2009-08-27 19:51:58 +0000723
Ted Kremenekfb480492010-01-13 21:46:36 +0000724//===----------------------------------------------------------------------===//
Douglas Gregor1db19de2010-01-19 21:36:55 +0000725// CXSourceLocation and CXSourceRange Operations.
726//===----------------------------------------------------------------------===//
727
728void clang_getInstantiationLocation(CXSourceLocation location,
729 CXFile *file,
730 unsigned *line,
731 unsigned *column) {
732 CXSourceLocationPtr Ptr
733 = CXSourceLocationPtr::getFromOpaqueValue(location.ptr_data);
734 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
735
736 if (!Ptr.getPointer() || Loc.isInvalid()) {
737 if (file)
738 *file = 0;
739 if (line)
740 *line = 0;
741 if (column)
742 *column = 0;
743 return;
744 }
745
746 // FIXME: This is largely copy-paste from
747 ///TextDiagnosticPrinter::HighlightRange. When it is clear that this is
748 // what we want the two routines should be refactored.
749 ASTContext &Context = *Ptr.getPointer();
750 SourceManager &SM = Context.getSourceManager();
751 SourceLocation InstLoc = SM.getInstantiationLoc(Loc);
752
753 if (Ptr.getInt()) {
754 // We want the last character in this location, so we will adjust
755 // the instantiation location accordingly.
756
757 // If the location is from a macro instantiation, get the end of
758 // the instantiation range.
759 if (Loc.isMacroID())
760 InstLoc = SM.getInstantiationRange(Loc).second;
761
762 // Measure the length token we're pointing at, so we can adjust
763 // the physical location in the file to point at the last
764 // character.
765 // FIXME: This won't cope with trigraphs or escaped newlines
766 // well. For that, we actually need a preprocessor, which isn't
767 // currently available here. Eventually, we'll switch the pointer
768 // data of CXSourceLocation/CXSourceRange to a translation unit
769 // (CXXUnit), so that the preprocessor will be available here. At
770 // that point, we can use Preprocessor::getLocForEndOfToken().
771 unsigned Length = Lexer::MeasureTokenLength(InstLoc, SM,
772 Context.getLangOptions());
773 if (Length > 0)
774 InstLoc = InstLoc.getFileLocWithOffset(Length - 1);
775 }
776
777 if (file)
778 *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc));
779 if (line)
780 *line = SM.getInstantiationLineNumber(InstLoc);
781 if (column)
782 *column = SM.getInstantiationColumnNumber(InstLoc);
783}
784
785CXSourceLocation clang_getRangeStart(CXSourceRange range) {
786 CXSourceLocation Result = { range.ptr_data, range.begin_int_data };
787 return Result;
788}
789
790CXSourceLocation clang_getRangeEnd(CXSourceRange range) {
791 llvm::PointerIntPair<ASTContext *, 1, bool> Ptr;
792 Ptr.setPointer(static_cast<ASTContext *>(range.ptr_data));
793 Ptr.setInt(true);
794 CXSourceLocation Result = { Ptr.getOpaqueValue(), range.end_int_data };
795 return Result;
796}
797
798//===----------------------------------------------------------------------===//
Ted Kremenekfb480492010-01-13 21:46:36 +0000799// CXFile Operations.
800//===----------------------------------------------------------------------===//
801
802extern "C" {
Steve Naroff88145032009-10-27 14:35:18 +0000803const char *clang_getFileName(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +0000804 if (!SFile)
805 return 0;
806
Steve Naroff88145032009-10-27 14:35:18 +0000807 assert(SFile && "Passed null CXFile");
808 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
809 return FEnt->getName();
810}
811
812time_t clang_getFileTime(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +0000813 if (!SFile)
814 return 0;
815
Steve Naroff88145032009-10-27 14:35:18 +0000816 assert(SFile && "Passed null CXFile");
817 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
818 return FEnt->getModificationTime();
Steve Naroffee9405e2009-09-25 21:45:39 +0000819}
Ted Kremenekfb480492010-01-13 21:46:36 +0000820} // end: extern "C"
Steve Naroffee9405e2009-09-25 21:45:39 +0000821
Ted Kremenekfb480492010-01-13 21:46:36 +0000822//===----------------------------------------------------------------------===//
823// CXCursor Operations.
824//===----------------------------------------------------------------------===//
825
Ted Kremenekfb480492010-01-13 21:46:36 +0000826static Decl *getDeclFromExpr(Stmt *E) {
827 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
828 return RefExpr->getDecl();
829 if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
830 return ME->getMemberDecl();
831 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
832 return RE->getDecl();
833
834 if (CallExpr *CE = dyn_cast<CallExpr>(E))
835 return getDeclFromExpr(CE->getCallee());
836 if (CastExpr *CE = dyn_cast<CastExpr>(E))
837 return getDeclFromExpr(CE->getSubExpr());
838 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
839 return OME->getMethodDecl();
840
841 return 0;
842}
843
844extern "C" {
Douglas Gregorb1373d02010-01-20 20:59:29 +0000845
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000846unsigned clang_visitChildren(CXCursor parent,
Douglas Gregorb1373d02010-01-20 20:59:29 +0000847 CXCursorVisitor visitor,
848 CXClientData client_data) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000849 ASTUnit *CXXUnit = getCursorASTUnit(parent);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000850
851 unsigned PCHLevel = Decl::MaxPCHLevel;
852
853 // Set the PCHLevel to filter out unwanted decls if requested.
854 if (CXXUnit->getOnlyLocalDecls()) {
855 PCHLevel = 0;
856
857 // If the main input was an AST, bump the level.
858 if (CXXUnit->isMainFileAST())
859 ++PCHLevel;
860 }
861
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000862 CursorVisitor CursorVis(CXXUnit, visitor, client_data, PCHLevel);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000863 return CursorVis.VisitChildren(parent);
864}
865
Douglas Gregor78205d42010-01-20 21:45:58 +0000866static CXString getDeclSpelling(Decl *D) {
867 NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D);
868 if (!ND)
869 return CIndexer::createCXString("");
870
871 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
872 return CIndexer::createCXString(OMD->getSelector().getAsString().c_str(),
873 true);
874
875 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
876 // No, this isn't the same as the code below. getIdentifier() is non-virtual
877 // and returns different names. NamedDecl returns the class name and
878 // ObjCCategoryImplDecl returns the category name.
879 return CIndexer::createCXString(CIMP->getIdentifier()->getNameStart());
880
881 if (ND->getIdentifier())
882 return CIndexer::createCXString(ND->getIdentifier()->getNameStart());
883
884 return CIndexer::createCXString("");
885}
886
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000887CXString clang_getCursorSpelling(CXCursor C) {
Daniel Dunbarc81d7182010-01-18 17:52:42 +0000888 assert(getCursorDecl(C) && "CXCursor has null decl");
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +0000889 if (clang_isTranslationUnit(C.kind))
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000890 return clang_getTranslationUnitSpelling(C.data[2]);
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +0000891
Steve Narofff334b4e2009-09-02 18:26:48 +0000892 if (clang_isReference(C.kind)) {
893 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000894 case CXCursor_ObjCSuperClassRef: {
Douglas Gregor2e331b92010-01-16 14:00:32 +0000895 ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
896 return CIndexer::createCXString(Super->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +0000897 }
898 case CXCursor_ObjCClassRef: {
Douglas Gregor1adb0822010-01-16 17:14:40 +0000899 ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
900 return CIndexer::createCXString(Class->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +0000901 }
902 case CXCursor_ObjCProtocolRef: {
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000903 ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
Douglas Gregorf46034a2010-01-18 23:41:10 +0000904 assert(OID && "getCursorSpelling(): Missing protocol decl");
Ted Kremenek4b333d22010-01-12 00:36:38 +0000905 return CIndexer::createCXString(OID->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +0000906 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000907 case CXCursor_TypeRef: {
908 TypeDecl *Type = getCursorTypeRef(C).first;
909 assert(Type && "Missing type decl");
910
911 return CIndexer::createCXString(
912 getCursorContext(C).getTypeDeclType(Type).getAsString().c_str(),
913 true);
914 }
915
Daniel Dunbaracca7252009-11-30 20:42:49 +0000916 default:
Ted Kremenek4b333d22010-01-12 00:36:38 +0000917 return CIndexer::createCXString("<not implemented>");
Steve Narofff334b4e2009-09-02 18:26:48 +0000918 }
919 }
Douglas Gregor97b98722010-01-19 23:20:36 +0000920
921 if (clang_isExpression(C.kind)) {
922 Decl *D = getDeclFromExpr(getCursorExpr(C));
923 if (D)
Douglas Gregor78205d42010-01-20 21:45:58 +0000924 return getDeclSpelling(D);
Douglas Gregor97b98722010-01-19 23:20:36 +0000925 return CIndexer::createCXString("");
926 }
927
Douglas Gregor78205d42010-01-20 21:45:58 +0000928 return getDeclSpelling(getCursorDecl(C));
Steve Narofff334b4e2009-09-02 18:26:48 +0000929}
930
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000931const char *clang_getCursorKindSpelling(enum CXCursorKind Kind) {
Steve Naroff89922f82009-08-31 00:59:03 +0000932 switch (Kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000933 case CXCursor_FunctionDecl: return "FunctionDecl";
934 case CXCursor_TypedefDecl: return "TypedefDecl";
935 case CXCursor_EnumDecl: return "EnumDecl";
936 case CXCursor_EnumConstantDecl: return "EnumConstantDecl";
937 case CXCursor_StructDecl: return "StructDecl";
938 case CXCursor_UnionDecl: return "UnionDecl";
939 case CXCursor_ClassDecl: return "ClassDecl";
940 case CXCursor_FieldDecl: return "FieldDecl";
941 case CXCursor_VarDecl: return "VarDecl";
942 case CXCursor_ParmDecl: return "ParmDecl";
943 case CXCursor_ObjCInterfaceDecl: return "ObjCInterfaceDecl";
944 case CXCursor_ObjCCategoryDecl: return "ObjCCategoryDecl";
945 case CXCursor_ObjCProtocolDecl: return "ObjCProtocolDecl";
946 case CXCursor_ObjCPropertyDecl: return "ObjCPropertyDecl";
947 case CXCursor_ObjCIvarDecl: return "ObjCIvarDecl";
948 case CXCursor_ObjCInstanceMethodDecl: return "ObjCInstanceMethodDecl";
949 case CXCursor_ObjCClassMethodDecl: return "ObjCClassMethodDecl";
Douglas Gregorb6998662010-01-19 19:34:47 +0000950 case CXCursor_ObjCImplementationDecl: return "ObjCImplementationDecl";
951 case CXCursor_ObjCCategoryImplDecl: return "ObjCCategoryImplDecl";
Douglas Gregor30122132010-01-19 22:07:56 +0000952 case CXCursor_UnexposedDecl: return "UnexposedDecl";
Daniel Dunbaracca7252009-11-30 20:42:49 +0000953 case CXCursor_ObjCSuperClassRef: return "ObjCSuperClassRef";
954 case CXCursor_ObjCProtocolRef: return "ObjCProtocolRef";
955 case CXCursor_ObjCClassRef: return "ObjCClassRef";
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000956 case CXCursor_TypeRef: return "TypeRef";
Douglas Gregor97b98722010-01-19 23:20:36 +0000957 case CXCursor_UnexposedExpr: return "UnexposedExpr";
958 case CXCursor_DeclRefExpr: return "DeclRefExpr";
959 case CXCursor_MemberRefExpr: return "MemberRefExpr";
960 case CXCursor_CallExpr: return "CallExpr";
961 case CXCursor_ObjCMessageExpr: return "ObjCMessageExpr";
962 case CXCursor_UnexposedStmt: return "UnexposedStmt";
Daniel Dunbaracca7252009-11-30 20:42:49 +0000963 case CXCursor_InvalidFile: return "InvalidFile";
964 case CXCursor_NoDeclFound: return "NoDeclFound";
965 case CXCursor_NotImplemented: return "NotImplemented";
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +0000966 case CXCursor_TranslationUnit: return "TranslationUnit";
Steve Naroff89922f82009-08-31 00:59:03 +0000967 }
Ted Kremenekdeb06bd2010-01-16 02:02:09 +0000968
969 llvm_unreachable("Unhandled CXCursorKind");
970 return NULL;
Steve Naroff600866c2009-08-27 19:51:58 +0000971}
Steve Naroff89922f82009-08-31 00:59:03 +0000972
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000973CXCursor clang_getCursor(CXTranslationUnit CTUnit, const char *source_name,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000974 unsigned line, unsigned column) {
Steve Naroff9efa7672009-09-04 15:44:05 +0000975 assert(CTUnit && "Passed null CXTranslationUnit");
976 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000977
Steve Naroff9efa7672009-09-04 15:44:05 +0000978 FileManager &FMgr = CXXUnit->getFileManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000979 const FileEntry *File = FMgr.getFile(source_name,
980 source_name+strlen(source_name));
Ted Kremenekf4629892010-01-14 01:51:23 +0000981 if (!File)
982 return clang_getNullCursor();
983
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000984 SourceLocation SLoc =
Steve Naroff9efa7672009-09-04 15:44:05 +0000985 CXXUnit->getSourceManager().getLocation(File, line, column);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000986
Steve Narofff96b5242009-10-28 20:44:47 +0000987 ASTLocation LastLoc = CXXUnit->getLastASTLocation();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000988 ASTLocation ALoc = ResolveLocationInAST(CXXUnit->getASTContext(), SLoc,
Steve Narofff96b5242009-10-28 20:44:47 +0000989 &LastLoc);
Ted Kremenekf4629892010-01-14 01:51:23 +0000990
991 // FIXME: This doesn't look thread-safe.
Steve Narofff96b5242009-10-28 20:44:47 +0000992 if (ALoc.isValid())
993 CXXUnit->setLastASTLocation(ALoc);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000994
Argyrios Kyrtzidisf4526e32009-09-29 19:44:27 +0000995 Decl *Dcl = ALoc.getParentDecl();
Argyrios Kyrtzidis05a76512009-09-29 19:45:58 +0000996 if (ALoc.isNamedRef())
997 Dcl = ALoc.AsNamedRef().ND;
Argyrios Kyrtzidisf4526e32009-09-29 19:44:27 +0000998 Stmt *Stm = ALoc.dyn_AsStmt();
Steve Naroff4ade6d62009-09-23 17:52:52 +0000999 if (Dcl) {
Douglas Gregor97b98722010-01-19 23:20:36 +00001000 if (Stm)
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001001 return MakeCXCursor(Stm, Dcl, CXXUnit);
Douglas Gregor97b98722010-01-19 23:20:36 +00001002
Steve Naroff85e2db72009-10-01 00:31:07 +00001003 if (ALoc.isNamedRef()) {
Douglas Gregor1adb0822010-01-16 17:14:40 +00001004 if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(Dcl))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001005 return MakeCursorObjCClassRef(Class, ALoc.AsNamedRef().Loc, CXXUnit);
Douglas Gregor78db0cd2010-01-16 15:44:18 +00001006 if (ObjCProtocolDecl *Proto = dyn_cast<ObjCProtocolDecl>(Dcl))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001007 return MakeCursorObjCProtocolRef(Proto, ALoc.AsNamedRef().Loc, CXXUnit);
Steve Naroff85e2db72009-10-01 00:31:07 +00001008 }
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001009 return MakeCXCursor(Dcl, CXXUnit);
Steve Naroff77128dd2009-09-15 20:25:34 +00001010 }
Douglas Gregor5bfb8c12010-01-20 23:34:41 +00001011 return MakeCXCursorInvalid(CXCursor_NoDeclFound);
Steve Naroff600866c2009-08-27 19:51:58 +00001012}
1013
Ted Kremenek73885552009-11-17 19:28:59 +00001014CXCursor clang_getNullCursor(void) {
Douglas Gregor5bfb8c12010-01-20 23:34:41 +00001015 return MakeCXCursorInvalid(CXCursor_InvalidFile);
Ted Kremenek73885552009-11-17 19:28:59 +00001016}
1017
1018unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
Douglas Gregor283cae32010-01-15 21:56:13 +00001019 return X == Y;
Ted Kremenek73885552009-11-17 19:28:59 +00001020}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001021
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001022unsigned clang_isInvalid(enum CXCursorKind K) {
Steve Naroff77128dd2009-09-15 20:25:34 +00001023 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
1024}
1025
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001026unsigned clang_isDeclaration(enum CXCursorKind K) {
Steve Naroff89922f82009-08-31 00:59:03 +00001027 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
1028}
Steve Naroff2d4d6292009-08-31 14:26:51 +00001029
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001030unsigned clang_isReference(enum CXCursorKind K) {
Steve Narofff334b4e2009-09-02 18:26:48 +00001031 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
1032}
1033
Douglas Gregor97b98722010-01-19 23:20:36 +00001034unsigned clang_isExpression(enum CXCursorKind K) {
1035 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
1036}
1037
1038unsigned clang_isStatement(enum CXCursorKind K) {
1039 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
1040}
1041
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00001042unsigned clang_isTranslationUnit(enum CXCursorKind K) {
1043 return K == CXCursor_TranslationUnit;
1044}
1045
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001046CXCursorKind clang_getCursorKind(CXCursor C) {
Steve Naroff9efa7672009-09-04 15:44:05 +00001047 return C.kind;
1048}
1049
Douglas Gregor97b98722010-01-19 23:20:36 +00001050static SourceLocation getLocationFromExpr(Expr *E) {
1051 if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
1052 return /*FIXME:*/Msg->getLeftLoc();
1053 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
1054 return DRE->getLocation();
1055 if (MemberExpr *Member = dyn_cast<MemberExpr>(E))
1056 return Member->getMemberLoc();
1057 if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
1058 return Ivar->getLocation();
1059 return E->getLocStart();
1060}
1061
Douglas Gregor98258af2010-01-18 22:46:11 +00001062CXSourceLocation clang_getCursorLocation(CXCursor C) {
1063 if (clang_isReference(C.kind)) {
Douglas Gregorf46034a2010-01-18 23:41:10 +00001064 switch (C.kind) {
1065 case CXCursor_ObjCSuperClassRef: {
1066 std::pair<ObjCInterfaceDecl *, SourceLocation> P
1067 = getCursorObjCSuperClassRef(C);
Douglas Gregor1db19de2010-01-19 21:36:55 +00001068 return translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001069 }
1070
1071 case CXCursor_ObjCProtocolRef: {
1072 std::pair<ObjCProtocolDecl *, SourceLocation> P
1073 = getCursorObjCProtocolRef(C);
Douglas Gregor1db19de2010-01-19 21:36:55 +00001074 return translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001075 }
1076
1077 case CXCursor_ObjCClassRef: {
1078 std::pair<ObjCInterfaceDecl *, SourceLocation> P
1079 = getCursorObjCClassRef(C);
Douglas Gregor1db19de2010-01-19 21:36:55 +00001080 return translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001081 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001082
1083 case CXCursor_TypeRef: {
1084 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
1085 return translateSourceLocation(P.first->getASTContext(), P.second);
1086 }
Douglas Gregorf46034a2010-01-18 23:41:10 +00001087
Douglas Gregorf46034a2010-01-18 23:41:10 +00001088 default:
1089 // FIXME: Need a way to enumerate all non-reference cases.
1090 llvm_unreachable("Missed a reference kind");
1091 }
Douglas Gregor98258af2010-01-18 22:46:11 +00001092 }
Douglas Gregor97b98722010-01-19 23:20:36 +00001093
1094 if (clang_isExpression(C.kind))
1095 return translateSourceLocation(getCursorContext(C),
1096 getLocationFromExpr(getCursorExpr(C)));
1097
Douglas Gregor98258af2010-01-18 22:46:11 +00001098 if (!getCursorDecl(C)) {
Douglas Gregor1db19de2010-01-19 21:36:55 +00001099 CXSourceLocation empty = { 0, 0 };
Douglas Gregor98258af2010-01-18 22:46:11 +00001100 return empty;
1101 }
1102
Douglas Gregorf46034a2010-01-18 23:41:10 +00001103 Decl *D = getCursorDecl(C);
Douglas Gregorf46034a2010-01-18 23:41:10 +00001104 SourceLocation Loc = D->getLocation();
1105 if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D))
1106 Loc = Class->getClassLoc();
Douglas Gregor1db19de2010-01-19 21:36:55 +00001107 return translateSourceLocation(D->getASTContext(), Loc);
Douglas Gregor98258af2010-01-18 22:46:11 +00001108}
Douglas Gregora7bde202010-01-19 00:34:46 +00001109
1110CXSourceRange clang_getCursorExtent(CXCursor C) {
1111 if (clang_isReference(C.kind)) {
1112 switch (C.kind) {
1113 case CXCursor_ObjCSuperClassRef: {
1114 std::pair<ObjCInterfaceDecl *, SourceLocation> P
1115 = getCursorObjCSuperClassRef(C);
1116 return translateSourceRange(P.first->getASTContext(), P.second);
1117 }
1118
1119 case CXCursor_ObjCProtocolRef: {
1120 std::pair<ObjCProtocolDecl *, SourceLocation> P
1121 = getCursorObjCProtocolRef(C);
1122 return translateSourceRange(P.first->getASTContext(), P.second);
1123 }
1124
1125 case CXCursor_ObjCClassRef: {
1126 std::pair<ObjCInterfaceDecl *, SourceLocation> P
1127 = getCursorObjCClassRef(C);
1128
1129 return translateSourceRange(P.first->getASTContext(), P.second);
1130 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001131
1132 case CXCursor_TypeRef: {
1133 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
1134 return translateSourceRange(P.first->getASTContext(), P.second);
1135 }
Douglas Gregora7bde202010-01-19 00:34:46 +00001136
Douglas Gregora7bde202010-01-19 00:34:46 +00001137 default:
1138 // FIXME: Need a way to enumerate all non-reference cases.
1139 llvm_unreachable("Missed a reference kind");
1140 }
1141 }
Douglas Gregor97b98722010-01-19 23:20:36 +00001142
1143 if (clang_isExpression(C.kind))
1144 return translateSourceRange(getCursorContext(C),
1145 getCursorExpr(C)->getSourceRange());
Douglas Gregora7bde202010-01-19 00:34:46 +00001146
1147 if (!getCursorDecl(C)) {
Douglas Gregor1db19de2010-01-19 21:36:55 +00001148 CXSourceRange empty = { 0, 0, 0 };
Douglas Gregora7bde202010-01-19 00:34:46 +00001149 return empty;
1150 }
1151
1152 Decl *D = getCursorDecl(C);
1153 return translateSourceRange(D->getASTContext(), D->getSourceRange());
1154}
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001155
1156CXCursor clang_getCursorReferenced(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001157 if (clang_isInvalid(C.kind))
1158 return clang_getNullCursor();
1159
1160 ASTUnit *CXXUnit = getCursorASTUnit(C);
Douglas Gregorb6998662010-01-19 19:34:47 +00001161 if (clang_isDeclaration(C.kind))
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001162 return C;
Douglas Gregor98258af2010-01-18 22:46:11 +00001163
Douglas Gregor97b98722010-01-19 23:20:36 +00001164 if (clang_isExpression(C.kind)) {
1165 Decl *D = getDeclFromExpr(getCursorExpr(C));
1166 if (D)
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001167 return MakeCXCursor(D, CXXUnit);
Douglas Gregor97b98722010-01-19 23:20:36 +00001168 return clang_getNullCursor();
1169 }
1170
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001171 if (!clang_isReference(C.kind))
1172 return clang_getNullCursor();
1173
1174 switch (C.kind) {
1175 case CXCursor_ObjCSuperClassRef:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001176 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, CXXUnit);
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001177
1178 case CXCursor_ObjCProtocolRef: {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001179 return MakeCXCursor(getCursorObjCProtocolRef(C).first, CXXUnit);
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001180
1181 case CXCursor_ObjCClassRef:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001182 return MakeCXCursor(getCursorObjCClassRef(C).first, CXXUnit);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001183
1184 case CXCursor_TypeRef:
1185 return MakeCXCursor(getCursorTypeRef(C).first, CXXUnit);
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001186
Douglas Gregorc5d1e932010-01-19 01:20:04 +00001187 default:
1188 // We would prefer to enumerate all non-reference cursor kinds here.
1189 llvm_unreachable("Unhandled reference cursor kind");
1190 break;
1191 }
1192 }
1193
1194 return clang_getNullCursor();
1195}
1196
Douglas Gregorb6998662010-01-19 19:34:47 +00001197CXCursor clang_getCursorDefinition(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001198 if (clang_isInvalid(C.kind))
1199 return clang_getNullCursor();
1200
1201 ASTUnit *CXXUnit = getCursorASTUnit(C);
1202
Douglas Gregorb6998662010-01-19 19:34:47 +00001203 bool WasReference = false;
Douglas Gregor97b98722010-01-19 23:20:36 +00001204 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
Douglas Gregorb6998662010-01-19 19:34:47 +00001205 C = clang_getCursorReferenced(C);
1206 WasReference = true;
1207 }
1208
1209 if (!clang_isDeclaration(C.kind))
1210 return clang_getNullCursor();
1211
1212 Decl *D = getCursorDecl(C);
1213 if (!D)
1214 return clang_getNullCursor();
1215
1216 switch (D->getKind()) {
1217 // Declaration kinds that don't really separate the notions of
1218 // declaration and definition.
1219 case Decl::Namespace:
1220 case Decl::Typedef:
1221 case Decl::TemplateTypeParm:
1222 case Decl::EnumConstant:
1223 case Decl::Field:
1224 case Decl::ObjCIvar:
1225 case Decl::ObjCAtDefsField:
1226 case Decl::ImplicitParam:
1227 case Decl::ParmVar:
1228 case Decl::NonTypeTemplateParm:
1229 case Decl::TemplateTemplateParm:
1230 case Decl::ObjCCategoryImpl:
1231 case Decl::ObjCImplementation:
1232 case Decl::LinkageSpec:
1233 case Decl::ObjCPropertyImpl:
1234 case Decl::FileScopeAsm:
1235 case Decl::StaticAssert:
1236 case Decl::Block:
1237 return C;
1238
1239 // Declaration kinds that don't make any sense here, but are
1240 // nonetheless harmless.
1241 case Decl::TranslationUnit:
1242 case Decl::Template:
1243 case Decl::ObjCContainer:
1244 break;
1245
1246 // Declaration kinds for which the definition is not resolvable.
1247 case Decl::UnresolvedUsingTypename:
1248 case Decl::UnresolvedUsingValue:
1249 break;
1250
1251 case Decl::UsingDirective:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001252 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
1253 CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001254
1255 case Decl::NamespaceAlias:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001256 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001257
1258 case Decl::Enum:
1259 case Decl::Record:
1260 case Decl::CXXRecord:
1261 case Decl::ClassTemplateSpecialization:
1262 case Decl::ClassTemplatePartialSpecialization:
1263 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition(D->getASTContext()))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001264 return MakeCXCursor(Def, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001265 return clang_getNullCursor();
1266
1267 case Decl::Function:
1268 case Decl::CXXMethod:
1269 case Decl::CXXConstructor:
1270 case Decl::CXXDestructor:
1271 case Decl::CXXConversion: {
1272 const FunctionDecl *Def = 0;
1273 if (cast<FunctionDecl>(D)->getBody(Def))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001274 return MakeCXCursor(const_cast<FunctionDecl *>(Def), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001275 return clang_getNullCursor();
1276 }
1277
1278 case Decl::Var: {
1279 VarDecl *Var = cast<VarDecl>(D);
1280
1281 // Variables with initializers have definitions.
1282 const VarDecl *Def = 0;
1283 if (Var->getDefinition(Def))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001284 return MakeCXCursor(const_cast<VarDecl *>(Def), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001285
1286 // extern and private_extern variables are not definitions.
1287 if (Var->hasExternalStorage())
1288 return clang_getNullCursor();
1289
1290 // In-line static data members do not have definitions.
1291 if (Var->isStaticDataMember() && !Var->isOutOfLine())
1292 return clang_getNullCursor();
1293
1294 // All other variables are themselves definitions.
1295 return C;
1296 }
1297
1298 case Decl::FunctionTemplate: {
1299 const FunctionDecl *Def = 0;
1300 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001301 return MakeCXCursor(Def->getDescribedFunctionTemplate(), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001302 return clang_getNullCursor();
1303 }
1304
1305 case Decl::ClassTemplate: {
1306 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
1307 ->getDefinition(D->getASTContext()))
1308 return MakeCXCursor(
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001309 cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
1310 CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001311 return clang_getNullCursor();
1312 }
1313
1314 case Decl::Using: {
1315 UsingDecl *Using = cast<UsingDecl>(D);
1316 CXCursor Def = clang_getNullCursor();
1317 for (UsingDecl::shadow_iterator S = Using->shadow_begin(),
1318 SEnd = Using->shadow_end();
1319 S != SEnd; ++S) {
1320 if (Def != clang_getNullCursor()) {
1321 // FIXME: We have no way to return multiple results.
1322 return clang_getNullCursor();
1323 }
1324
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001325 Def = clang_getCursorDefinition(MakeCXCursor((*S)->getTargetDecl(),
1326 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00001327 }
1328
1329 return Def;
1330 }
1331
1332 case Decl::UsingShadow:
1333 return clang_getCursorDefinition(
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001334 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
1335 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00001336
1337 case Decl::ObjCMethod: {
1338 ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
1339 if (Method->isThisDeclarationADefinition())
1340 return C;
1341
1342 // Dig out the method definition in the associated
1343 // @implementation, if we have it.
1344 // FIXME: The ASTs should make finding the definition easier.
1345 if (ObjCInterfaceDecl *Class
1346 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
1347 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
1348 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
1349 Method->isInstanceMethod()))
1350 if (Def->isThisDeclarationADefinition())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001351 return MakeCXCursor(Def, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001352
1353 return clang_getNullCursor();
1354 }
1355
1356 case Decl::ObjCCategory:
1357 if (ObjCCategoryImplDecl *Impl
1358 = cast<ObjCCategoryDecl>(D)->getImplementation())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001359 return MakeCXCursor(Impl, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001360 return clang_getNullCursor();
1361
1362 case Decl::ObjCProtocol:
1363 if (!cast<ObjCProtocolDecl>(D)->isForwardDecl())
1364 return C;
1365 return clang_getNullCursor();
1366
1367 case Decl::ObjCInterface:
1368 // There are two notions of a "definition" for an Objective-C
1369 // class: the interface and its implementation. When we resolved a
1370 // reference to an Objective-C class, produce the @interface as
1371 // the definition; when we were provided with the interface,
1372 // produce the @implementation as the definition.
1373 if (WasReference) {
1374 if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl())
1375 return C;
1376 } else if (ObjCImplementationDecl *Impl
1377 = cast<ObjCInterfaceDecl>(D)->getImplementation())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001378 return MakeCXCursor(Impl, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001379 return clang_getNullCursor();
1380
1381 case Decl::ObjCProperty:
1382 // FIXME: We don't really know where to find the
1383 // ObjCPropertyImplDecls that implement this property.
1384 return clang_getNullCursor();
1385
1386 case Decl::ObjCCompatibleAlias:
1387 if (ObjCInterfaceDecl *Class
1388 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
1389 if (!Class->isForwardDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001390 return MakeCXCursor(Class, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001391
1392 return clang_getNullCursor();
1393
1394 case Decl::ObjCForwardProtocol: {
1395 ObjCForwardProtocolDecl *Forward = cast<ObjCForwardProtocolDecl>(D);
1396 if (Forward->protocol_size() == 1)
1397 return clang_getCursorDefinition(
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001398 MakeCXCursor(*Forward->protocol_begin(),
1399 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00001400
1401 // FIXME: Cannot return multiple definitions.
1402 return clang_getNullCursor();
1403 }
1404
1405 case Decl::ObjCClass: {
1406 ObjCClassDecl *Class = cast<ObjCClassDecl>(D);
1407 if (Class->size() == 1) {
1408 ObjCInterfaceDecl *IFace = Class->begin()->getInterface();
1409 if (!IFace->isForwardDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001410 return MakeCXCursor(IFace, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00001411 return clang_getNullCursor();
1412 }
1413
1414 // FIXME: Cannot return multiple definitions.
1415 return clang_getNullCursor();
1416 }
1417
1418 case Decl::Friend:
1419 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001420 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00001421 return clang_getNullCursor();
1422
1423 case Decl::FriendTemplate:
1424 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001425 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00001426 return clang_getNullCursor();
1427 }
1428
1429 return clang_getNullCursor();
1430}
1431
1432unsigned clang_isCursorDefinition(CXCursor C) {
1433 if (!clang_isDeclaration(C.kind))
1434 return 0;
1435
1436 return clang_getCursorDefinition(C) == C;
1437}
1438
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001439void clang_getDefinitionSpellingAndExtent(CXCursor C,
Steve Naroff4ade6d62009-09-23 17:52:52 +00001440 const char **startBuf,
1441 const char **endBuf,
1442 unsigned *startLine,
1443 unsigned *startColumn,
1444 unsigned *endLine,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001445 unsigned *endColumn) {
Douglas Gregor283cae32010-01-15 21:56:13 +00001446 assert(getCursorDecl(C) && "CXCursor has null decl");
1447 NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C));
Steve Naroff4ade6d62009-09-23 17:52:52 +00001448 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
1449 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
Ted Kremenekfb480492010-01-13 21:46:36 +00001450
Steve Naroff4ade6d62009-09-23 17:52:52 +00001451 SourceManager &SM = FD->getASTContext().getSourceManager();
1452 *startBuf = SM.getCharacterData(Body->getLBracLoc());
1453 *endBuf = SM.getCharacterData(Body->getRBracLoc());
1454 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
1455 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
1456 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
1457 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
1458}
Ted Kremenekfb480492010-01-13 21:46:36 +00001459
1460} // end: extern "C"
Steve Naroff4ade6d62009-09-23 17:52:52 +00001461
Ted Kremenekfb480492010-01-13 21:46:36 +00001462//===----------------------------------------------------------------------===//
1463// CXString Operations.
1464//===----------------------------------------------------------------------===//
1465
1466extern "C" {
1467const char *clang_getCString(CXString string) {
1468 return string.Spelling;
1469}
1470
1471void clang_disposeString(CXString string) {
1472 if (string.MustFreeString && string.Spelling)
1473 free((void*)string.Spelling);
1474}
1475} // end: extern "C"