blob: de99658849827d3582cbd7d8d09af6deceb16396 [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//
10// This file implements the Clang-C Source Indexing library.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang-c/Index.h"
Steve Naroff50398192009-08-28 15:28:48 +000015#include "clang/Index/Program.h"
16#include "clang/Index/Indexer.h"
Steve Naroff9efa7672009-09-04 15:44:05 +000017#include "clang/Index/ASTLocation.h"
18#include "clang/Index/Utils.h"
Douglas Gregor0c8296d2009-11-07 00:00:49 +000019#include "clang/Sema/CodeCompleteConsumer.h"
Steve Naroff50398192009-08-28 15:28:48 +000020#include "clang/AST/DeclVisitor.h"
Steve Narofffb570422009-09-22 19:25:29 +000021#include "clang/AST/StmtVisitor.h"
Steve Naroffc857ea42009-09-02 13:28:54 +000022#include "clang/AST/Decl.h"
Benjamin Kramerd01a0bc2009-08-29 12:56:35 +000023#include "clang/Basic/FileManager.h"
Steve Naroff2d4d6292009-08-31 14:26:51 +000024#include "clang/Basic/SourceManager.h"
Benjamin Kramerd01a0bc2009-08-29 12:56:35 +000025#include "clang/Frontend/ASTUnit.h"
Douglas Gregor0c8296d2009-11-07 00:00:49 +000026#include "llvm/ADT/StringExtras.h"
27#include "llvm/ADT/StringSwitch.h"
Benjamin Kramer20d75812009-10-18 16:13:48 +000028#include "llvm/Config/config.h"
Ted Kremenekfc062212009-10-19 21:44:57 +000029#include "llvm/Support/Compiler.h"
Douglas Gregor02465752009-10-16 21:24:31 +000030#include "llvm/Support/MemoryBuffer.h"
31#include "llvm/System/Path.h"
Benjamin Kramer0829a832009-10-18 11:19:36 +000032#include "llvm/System/Program.h"
Ted Kremenek379afec2009-10-22 03:24:01 +000033#include "llvm/Support/raw_ostream.h"
Ted Kremenekfc062212009-10-19 21:44:57 +000034
Benjamin Kramerd01a0bc2009-08-29 12:56:35 +000035#include <cstdio>
Ted Kremenek49358d82009-10-19 21:17:25 +000036#include <vector>
Douglas Gregor0c8296d2009-11-07 00:00:49 +000037#include <sstream>
Ted Kremenek49358d82009-10-19 21:17:25 +000038
Benjamin Kramer20d75812009-10-18 16:13:48 +000039#ifdef LLVM_ON_WIN32
40#define WIN32_LEAN_AND_MEAN
41#include <windows.h>
42#else
Steve Naroff5b7d8e22009-10-15 20:04:39 +000043#include <dlfcn.h>
Daniel Dunbara47dd192009-10-17 23:53:11 +000044#endif
Steve Naroff5b7d8e22009-10-15 20:04:39 +000045
Steve Naroff50398192009-08-28 15:28:48 +000046using namespace clang;
47using namespace idx;
48
Steve Naroff89922f82009-08-31 00:59:03 +000049namespace {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +000050static enum CXCursorKind TranslateDeclRefExpr(DeclRefExpr *DRE)
Steve Naroff4ade6d62009-09-23 17:52:52 +000051{
52 NamedDecl *D = DRE->getDecl();
53 if (isa<VarDecl>(D))
54 return CXCursor_VarRef;
55 else if (isa<FunctionDecl>(D))
56 return CXCursor_FunctionRef;
57 else if (isa<EnumConstantDecl>(D))
58 return CXCursor_EnumConstantRef;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +000059 else
Steve Naroff4ade6d62009-09-23 17:52:52 +000060 return CXCursor_NotImplemented;
61}
62
63#if 0
64// Will be useful one day.
Steve Narofffb570422009-09-22 19:25:29 +000065class CRefVisitor : public StmtVisitor<CRefVisitor> {
66 CXDecl CDecl;
67 CXDeclIterator Callback;
68 CXClientData CData;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +000069
Steve Narofffb570422009-09-22 19:25:29 +000070 void Call(enum CXCursorKind CK, Stmt *SRef) {
71 CXCursor C = { CK, CDecl, SRef };
72 Callback(CDecl, C, CData);
73 }
74
75public:
Daniel Dunbar0d7dd222009-11-30 20:42:43 +000076 CRefVisitor(CXDecl C, CXDeclIterator cback, CXClientData D) :
Steve Narofffb570422009-09-22 19:25:29 +000077 CDecl(C), Callback(cback), CData(D) {}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +000078
Steve Narofffb570422009-09-22 19:25:29 +000079 void VisitStmt(Stmt *S) {
80 for (Stmt::child_iterator C = S->child_begin(), CEnd = S->child_end();
81 C != CEnd; ++C)
82 Visit(*C);
83 }
84 void VisitDeclRefExpr(DeclRefExpr *Node) {
Steve Naroff4ade6d62009-09-23 17:52:52 +000085 Call(TranslateDeclRefExpr(Node), Node);
Steve Narofffb570422009-09-22 19:25:29 +000086 }
87 void VisitMemberExpr(MemberExpr *Node) {
88 Call(CXCursor_MemberRef, Node);
89 }
90 void VisitObjCMessageExpr(ObjCMessageExpr *Node) {
91 Call(CXCursor_ObjCSelectorRef, Node);
92 }
93 void VisitObjCIvarRefExpr(ObjCIvarRefExpr *Node) {
94 Call(CXCursor_ObjCIvarRef, Node);
95 }
96};
Steve Naroff4ade6d62009-09-23 17:52:52 +000097#endif
Daniel Dunbar0d7dd222009-11-30 20:42:43 +000098
Ted Kremenekfc062212009-10-19 21:44:57 +000099/// IgnoreDiagnosticsClient - A DiagnosticsClient that just ignores emitted
100/// warnings and errors.
101class VISIBILITY_HIDDEN IgnoreDiagnosticsClient : public DiagnosticClient {
102public:
103 virtual ~IgnoreDiagnosticsClient() {}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000104 virtual void HandleDiagnostic(Diagnostic::Level, const DiagnosticInfo &) {}
Ted Kremenekfc062212009-10-19 21:44:57 +0000105};
Steve Narofffb570422009-09-22 19:25:29 +0000106
Steve Naroff89922f82009-08-31 00:59:03 +0000107// Translation Unit Visitor.
108class TUVisitor : public DeclVisitor<TUVisitor> {
109 CXTranslationUnit TUnit;
110 CXTranslationUnitIterator Callback;
Steve Naroff2b8ee6c2009-09-01 15:55:40 +0000111 CXClientData CData;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000112
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000113 // MaxPCHLevel - the maximum PCH level of declarations that we will pass on
114 // to the visitor. Declarations with a PCH level greater than this value will
115 // be suppressed.
116 unsigned MaxPCHLevel;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000117
Steve Naroff2b8ee6c2009-09-01 15:55:40 +0000118 void Call(enum CXCursorKind CK, NamedDecl *ND) {
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000119 // Filter any declarations that have a PCH level greater than what we allow.
120 if (ND->getPCHLevel() > MaxPCHLevel)
121 return;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000122
Steve Narofff96b5242009-10-28 20:44:47 +0000123 // Filter any implicit declarations (since the source info will be bogus).
124 if (ND->isImplicit())
125 return;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000126
Steve Narofffb570422009-09-22 19:25:29 +0000127 CXCursor C = { CK, ND, 0 };
Steve Naroff2b8ee6c2009-09-01 15:55:40 +0000128 Callback(TUnit, C, CData);
129 }
Steve Naroff89922f82009-08-31 00:59:03 +0000130public:
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000131 TUVisitor(CXTranslationUnit CTU,
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000132 CXTranslationUnitIterator cback, CXClientData D,
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000133 unsigned MaxPCHLevel) :
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000134 TUnit(CTU), Callback(cback), CData(D), MaxPCHLevel(MaxPCHLevel) {}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000135
Steve Naroff89922f82009-08-31 00:59:03 +0000136 void VisitTranslationUnitDecl(TranslationUnitDecl *D) {
137 VisitDeclContext(dyn_cast<DeclContext>(D));
138 }
139 void VisitDeclContext(DeclContext *DC) {
140 for (DeclContext::decl_iterator
141 I = DC->decls_begin(), E = DC->decls_end(); I != E; ++I)
142 Visit(*I);
143 }
Ted Kremenekef7fdc62009-11-17 07:02:15 +0000144
145 void VisitFunctionDecl(FunctionDecl *ND) {
146 Call(ND->isThisDeclarationADefinition() ? CXCursor_FunctionDefn
147 : CXCursor_FunctionDecl, ND);
148 }
149 void VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
150 Call(CXCursor_ObjCCategoryDecl, ND);
151 }
152 void VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *ND) {
153 Call(CXCursor_ObjCCategoryDefn, ND);
154 }
155 void VisitObjCImplementationDecl(ObjCImplementationDecl *ND) {
156 Call(CXCursor_ObjCClassDefn, ND);
157 }
158 void VisitObjCInterfaceDecl(ObjCInterfaceDecl *ND) {
159 Call(CXCursor_ObjCInterfaceDecl, ND);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000160 }
Ted Kremenekef7fdc62009-11-17 07:02:15 +0000161 void VisitObjCProtocolDecl(ObjCProtocolDecl *ND) {
162 Call(CXCursor_ObjCProtocolDecl, ND);
Steve Naroff89922f82009-08-31 00:59:03 +0000163 }
164 void VisitTagDecl(TagDecl *ND) {
Steve Naroffc857ea42009-09-02 13:28:54 +0000165 switch (ND->getTagKind()) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000166 case TagDecl::TK_struct:
167 Call(CXCursor_StructDecl, ND);
168 break;
169 case TagDecl::TK_class:
170 Call(CXCursor_ClassDecl, ND);
171 break;
172 case TagDecl::TK_union:
173 Call(CXCursor_UnionDecl, ND);
174 break;
175 case TagDecl::TK_enum:
176 Call(CXCursor_EnumDecl, ND);
177 break;
Steve Naroffc857ea42009-09-02 13:28:54 +0000178 }
Steve Naroff89922f82009-08-31 00:59:03 +0000179 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000180 void VisitTypedefDecl(TypedefDecl *ND) {
181 Call(CXCursor_TypedefDecl, ND);
182 }
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000183 void VisitVarDecl(VarDecl *ND) {
184 Call(CXCursor_VarDecl, ND);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000185 }
Steve Naroff89922f82009-08-31 00:59:03 +0000186};
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000187
Steve Naroff89922f82009-08-31 00:59:03 +0000188
Steve Naroffc857ea42009-09-02 13:28:54 +0000189// Declaration visitor.
190class CDeclVisitor : public DeclVisitor<CDeclVisitor> {
191 CXDecl CDecl;
192 CXDeclIterator Callback;
193 CXClientData CData;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000194
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000195 // MaxPCHLevel - the maximum PCH level of declarations that we will pass on
196 // to the visitor. Declarations with a PCH level greater than this value will
197 // be suppressed.
198 unsigned MaxPCHLevel;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000199
Steve Naroffc857ea42009-09-02 13:28:54 +0000200 void Call(enum CXCursorKind CK, NamedDecl *ND) {
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000201 // Disable the callback when the context is equal to the visiting decl.
202 if (CDecl == ND && !clang_isReference(CK))
203 return;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000204
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000205 // Filter any declarations that have a PCH level greater than what we allow.
206 if (ND->getPCHLevel() > MaxPCHLevel)
207 return;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000208
Steve Narofffb570422009-09-22 19:25:29 +0000209 CXCursor C = { CK, ND, 0 };
Steve Naroffc857ea42009-09-02 13:28:54 +0000210 Callback(CDecl, C, CData);
211 }
Steve Naroff89922f82009-08-31 00:59:03 +0000212public:
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000213 CDeclVisitor(CXDecl C, CXDeclIterator cback, CXClientData D,
214 unsigned MaxPCHLevel) :
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000215 CDecl(C), Callback(cback), CData(D), MaxPCHLevel(MaxPCHLevel) {}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000216
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000217 void VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
218 // Issue callbacks for the containing class.
219 Call(CXCursor_ObjCClassRef, ND);
220 // FIXME: Issue callbacks for protocol refs.
221 VisitDeclContext(dyn_cast<DeclContext>(ND));
222 }
Steve Naroffc857ea42009-09-02 13:28:54 +0000223 void VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000224 // Issue callbacks for super class.
Steve Narofff334b4e2009-09-02 18:26:48 +0000225 if (D->getSuperClass())
226 Call(CXCursor_ObjCSuperClassRef, D);
227
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000228 for (ObjCProtocolDecl::protocol_iterator I = D->protocol_begin(),
Daniel Dunbaracca7252009-11-30 20:42:49 +0000229 E = D->protocol_end(); I != E; ++I)
Steve Naroff9efa7672009-09-04 15:44:05 +0000230 Call(CXCursor_ObjCProtocolRef, *I);
Steve Naroffc857ea42009-09-02 13:28:54 +0000231 VisitDeclContext(dyn_cast<DeclContext>(D));
232 }
Steve Naroff9efa7672009-09-04 15:44:05 +0000233 void VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000234 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
Daniel Dunbaracca7252009-11-30 20:42:49 +0000235 E = PID->protocol_end(); I != E; ++I)
Steve Naroff9efa7672009-09-04 15:44:05 +0000236 Call(CXCursor_ObjCProtocolRef, *I);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000237
Steve Naroff9efa7672009-09-04 15:44:05 +0000238 VisitDeclContext(dyn_cast<DeclContext>(PID));
239 }
Steve Naroffc857ea42009-09-02 13:28:54 +0000240 void VisitTagDecl(TagDecl *D) {
241 VisitDeclContext(dyn_cast<DeclContext>(D));
242 }
243 void VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
244 VisitDeclContext(dyn_cast<DeclContext>(D));
245 }
246 void VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
247 VisitDeclContext(dyn_cast<DeclContext>(D));
248 }
Steve Naroff89922f82009-08-31 00:59:03 +0000249 void VisitDeclContext(DeclContext *DC) {
250 for (DeclContext::decl_iterator
251 I = DC->decls_begin(), E = DC->decls_end(); I != E; ++I)
252 Visit(*I);
253 }
254 void VisitEnumConstantDecl(EnumConstantDecl *ND) {
Steve Naroffc857ea42009-09-02 13:28:54 +0000255 Call(CXCursor_EnumConstantDecl, ND);
Steve Naroff89922f82009-08-31 00:59:03 +0000256 }
257 void VisitFieldDecl(FieldDecl *ND) {
Steve Naroffc857ea42009-09-02 13:28:54 +0000258 Call(CXCursor_FieldDecl, ND);
259 }
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000260 void VisitVarDecl(VarDecl *ND) {
261 Call(CXCursor_VarDecl, ND);
262 }
263 void VisitParmVarDecl(ParmVarDecl *ND) {
264 Call(CXCursor_ParmDecl, ND);
265 }
Steve Naroffc857ea42009-09-02 13:28:54 +0000266 void VisitObjCPropertyDecl(ObjCPropertyDecl *ND) {
267 Call(CXCursor_ObjCPropertyDecl, ND);
Steve Naroff89922f82009-08-31 00:59:03 +0000268 }
269 void VisitObjCIvarDecl(ObjCIvarDecl *ND) {
Steve Naroffc857ea42009-09-02 13:28:54 +0000270 Call(CXCursor_ObjCIvarDecl, ND);
271 }
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000272 void VisitFunctionDecl(FunctionDecl *ND) {
273 if (ND->isThisDeclarationADefinition()) {
274 VisitDeclContext(dyn_cast<DeclContext>(ND));
Steve Naroff4ade6d62009-09-23 17:52:52 +0000275#if 0
276 // Not currently needed.
277 CompoundStmt *Body = dyn_cast<CompoundStmt>(ND->getBody());
Steve Narofffb570422009-09-22 19:25:29 +0000278 CRefVisitor RVisit(CDecl, Callback, CData);
Steve Naroff4ade6d62009-09-23 17:52:52 +0000279 RVisit.Visit(Body);
280#endif
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000281 }
282 }
Steve Naroffc857ea42009-09-02 13:28:54 +0000283 void VisitObjCMethodDecl(ObjCMethodDecl *ND) {
284 if (ND->getBody()) {
285 Call(ND->isInstanceMethod() ? CXCursor_ObjCInstanceMethodDefn
286 : CXCursor_ObjCClassMethodDefn, ND);
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000287 VisitDeclContext(dyn_cast<DeclContext>(ND));
Steve Naroffc857ea42009-09-02 13:28:54 +0000288 } else
289 Call(ND->isInstanceMethod() ? CXCursor_ObjCInstanceMethodDecl
290 : CXCursor_ObjCClassMethodDecl, ND);
Steve Naroff89922f82009-08-31 00:59:03 +0000291 }
292};
293
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000294class CIndexer : public Indexer {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000295public:
296 explicit CIndexer(Program *prog) : Indexer(*prog),
297 OnlyLocalDecls(false),
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000298 DisplayDiagnostics(false) {}
Ted Kremenekdff76892009-10-17 06:21:47 +0000299
300 virtual ~CIndexer() { delete &getProgram(); }
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000301
302 /// \brief Whether we only want to see "local" declarations (that did not
303 /// come from a previous precompiled header). If false, we want to see all
304 /// declarations.
305 bool getOnlyLocalDecls() const { return OnlyLocalDecls; }
306 void setOnlyLocalDecls(bool Local = true) { OnlyLocalDecls = Local; }
Benjamin Kramer96707622009-10-18 11:10:55 +0000307
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000308 void setDisplayDiagnostics(bool Display = true) {
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000309 DisplayDiagnostics = Display;
310 }
311 bool getDisplayDiagnostics() const { return DisplayDiagnostics; }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000312
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000313 /// \brief Get the path of the clang binary.
Benjamin Kramerc5a9e952009-10-19 10:20:24 +0000314 const llvm::sys::Path& getClangPath();
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000315private:
316 bool OnlyLocalDecls;
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000317 bool DisplayDiagnostics;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000318
Benjamin Kramerc5a9e952009-10-19 10:20:24 +0000319 llvm::sys::Path ClangPath;
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000320};
Steve Naroff89922f82009-08-31 00:59:03 +0000321
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000322const llvm::sys::Path& CIndexer::getClangPath() {
323 // Did we already compute the path?
324 if (!ClangPath.empty())
325 return ClangPath;
326
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000327 // Find the location where this library lives (libCIndex.dylib).
Benjamin Kramer20d75812009-10-18 16:13:48 +0000328#ifdef LLVM_ON_WIN32
329 MEMORY_BASIC_INFORMATION mbi;
330 char path[MAX_PATH];
Benjamin Krameredcd8282009-10-18 16:20:58 +0000331 VirtualQuery((void *)(uintptr_t)clang_createTranslationUnit, &mbi,
Benjamin Kramer20d75812009-10-18 16:13:48 +0000332 sizeof(mbi));
333 GetModuleFileNameA((HINSTANCE)mbi.AllocationBase, path, MAX_PATH);
334
335 llvm::sys::Path CIndexPath(path);
John Thompson6a6742a2009-11-11 23:11:14 +0000336
337 CIndexPath.eraseComponent();
338 CIndexPath.appendComponent("clang");
339 CIndexPath.appendSuffix("exe");
340 CIndexPath.makeAbsolute();
Benjamin Kramer20d75812009-10-18 16:13:48 +0000341#else
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000342 // This silly cast below avoids a C++ warning.
343 Dl_info info;
344 if (dladdr((void *)(uintptr_t)clang_createTranslationUnit, &info) == 0)
345 assert(0 && "Call to dladdr() failed");
346
347 llvm::sys::Path CIndexPath(info.dli_fname);
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000348
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000349 // We now have the CIndex directory, locate clang relative to it.
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000350 CIndexPath.eraseComponent();
351 CIndexPath.eraseComponent();
352 CIndexPath.appendComponent("bin");
353 CIndexPath.appendComponent("clang");
John Thompson6a6742a2009-11-11 23:11:14 +0000354#endif
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000355
356 // Cache our result.
357 ClangPath = CIndexPath;
358 return ClangPath;
359}
360
361}
362
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000363static SourceLocation getLocationFromCursor(CXCursor C,
Daniel Dunbarc6190332009-11-08 04:13:53 +0000364 SourceManager &SourceMgr,
365 NamedDecl *ND) {
366 if (clang_isReference(C.kind)) {
367 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000368 case CXCursor_ObjCClassRef: {
369 if (isa<ObjCInterfaceDecl>(ND)) {
370 // FIXME: This is a hack (storing the parent decl in the stmt slot).
371 NamedDecl *parentDecl = static_cast<NamedDecl *>(C.stmt);
372 return parentDecl->getLocation();
Daniel Dunbarc6190332009-11-08 04:13:53 +0000373 }
Daniel Dunbaracca7252009-11-30 20:42:49 +0000374 ObjCCategoryDecl *OID = dyn_cast<ObjCCategoryDecl>(ND);
375 assert(OID && "clang_getCursorLine(): Missing category decl");
376 return OID->getClassInterface()->getLocation();
377 }
378 case CXCursor_ObjCSuperClassRef: {
379 ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(ND);
380 assert(OID && "clang_getCursorLine(): Missing interface decl");
381 return OID->getSuperClassLoc();
382 }
383 case CXCursor_ObjCProtocolRef: {
384 ObjCProtocolDecl *OID = dyn_cast<ObjCProtocolDecl>(ND);
385 assert(OID && "clang_getCursorLine(): Missing protocol decl");
386 return OID->getLocation();
387 }
388 case CXCursor_ObjCSelectorRef: {
389 ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(
390 static_cast<Stmt *>(C.stmt));
391 assert(OME && "clang_getCursorLine(): Missing message expr");
392 return OME->getLeftLoc(); /* FIXME: should be a range */
393 }
394 case CXCursor_VarRef:
395 case CXCursor_FunctionRef:
396 case CXCursor_EnumConstantRef: {
397 DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(
398 static_cast<Stmt *>(C.stmt));
399 assert(DRE && "clang_getCursorLine(): Missing decl ref expr");
400 return DRE->getLocation();
401 }
402 default:
403 return SourceLocation();
Daniel Dunbarc6190332009-11-08 04:13:53 +0000404 }
405 } else { // We have a declaration or a definition.
406 SourceLocation SLoc;
407 switch (ND->getKind()) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000408 case Decl::ObjCInterface: {
409 SLoc = dyn_cast<ObjCInterfaceDecl>(ND)->getClassLoc();
410 break;
411 }
412 case Decl::ObjCProtocol: {
413 SLoc = ND->getLocation(); /* FIXME: need to get the name location. */
414 break;
415 }
416 default: {
417 SLoc = ND->getLocation();
418 break;
419 }
Daniel Dunbarc6190332009-11-08 04:13:53 +0000420 }
421 if (SLoc.isInvalid())
422 return SourceLocation();
423 return SourceMgr.getSpellingLoc(SLoc); // handles macro instantiations.
424 }
425}
426
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000427static CXString createCXString(const char *String, bool DupString = false) {
428 CXString Str;
429 if (DupString) {
430 Str.Spelling = strdup(String);
431 Str.MustFreeString = 1;
432 } else {
433 Str.Spelling = String;
434 Str.MustFreeString = 0;
435 }
436 return Str;
437}
438
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000439extern "C" {
440
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000441CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000442 int displayDiagnostics)
443{
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000444 CIndexer *CIdxr = new CIndexer(new Program());
445 if (excludeDeclarationsFromPCH)
446 CIdxr->setOnlyLocalDecls();
447 if (displayDiagnostics)
448 CIdxr->setDisplayDiagnostics();
449 return CIdxr;
Steve Naroff600866c2009-08-27 19:51:58 +0000450}
451
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000452void clang_disposeIndex(CXIndex CIdx)
453{
454 assert(CIdx && "Passed null CXIndex");
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000455 delete static_cast<CIndexer *>(CIdx);
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000456}
457
Steve Naroff50398192009-08-28 15:28:48 +0000458// FIXME: need to pass back error info.
459CXTranslationUnit clang_createTranslationUnit(
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000460 CXIndex CIdx, const char *ast_filename)
Steve Naroff600866c2009-08-27 19:51:58 +0000461{
Steve Naroff50398192009-08-28 15:28:48 +0000462 assert(CIdx && "Passed null CXIndex");
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000463 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Steve Naroff50398192009-08-28 15:28:48 +0000464 std::string astName(ast_filename);
465 std::string ErrMsg;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000466
Ted Kremenek379afec2009-10-22 03:24:01 +0000467 CXTranslationUnit TU =
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000468 ASTUnit::LoadFromPCHFile(astName, &ErrMsg,
Daniel Dunbaracca7252009-11-30 20:42:49 +0000469 CXXIdx->getDisplayDiagnostics() ?
470 NULL : new IgnoreDiagnosticsClient(),
471 CXXIdx->getOnlyLocalDecls(),
472 /* UseBumpAllocator = */ true);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000473
Ted Kremenek0854d702009-11-10 19:18:52 +0000474 if (CXXIdx->getDisplayDiagnostics() && !ErrMsg.empty())
Ted Kremenek779e5f42009-10-26 22:08:39 +0000475 llvm::errs() << "clang_createTranslationUnit: " << ErrMsg << '\n';
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000476
Ted Kremenek379afec2009-10-22 03:24:01 +0000477 return TU;
Steve Naroff600866c2009-08-27 19:51:58 +0000478}
479
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000480CXTranslationUnit clang_createTranslationUnitFromSourceFile(
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000481 CXIndex CIdx,
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000482 const char *source_filename,
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000483 int num_command_line_args, const char **command_line_args) {
484 assert(CIdx && "Passed null CXIndex");
485 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
486
Ted Kremenek139ba862009-10-22 00:03:57 +0000487 // Build up the arguments for invoking 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000488 std::vector<const char *> argv;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000489
Ted Kremenek139ba862009-10-22 00:03:57 +0000490 // First add the complete path to the 'clang' executable.
491 llvm::sys::Path ClangPath = static_cast<CIndexer *>(CIdx)->getClangPath();
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000492 argv.push_back(ClangPath.c_str());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000493
Ted Kremenek139ba862009-10-22 00:03:57 +0000494 // Add the '-emit-ast' option as our execution mode for 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000495 argv.push_back("-emit-ast");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000496
Ted Kremenek139ba862009-10-22 00:03:57 +0000497 // The 'source_filename' argument is optional. If the caller does not
498 // specify it then it is assumed that the source file is specified
499 // in the actual argument list.
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000500 if (source_filename)
501 argv.push_back(source_filename);
Ted Kremenek139ba862009-10-22 00:03:57 +0000502
Steve Naroff37b5ac22009-10-15 20:50:09 +0000503 // Generate a temporary name for the AST file.
Ted Kremenek139ba862009-10-22 00:03:57 +0000504 argv.push_back("-o");
Steve Naroff37b5ac22009-10-15 20:50:09 +0000505 char astTmpFile[L_tmpnam];
Ted Kremenek74cd0692009-10-15 23:21:22 +0000506 argv.push_back(tmpnam(astTmpFile));
Ted Kremenek139ba862009-10-22 00:03:57 +0000507
508 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
509 for (int i = 0; i < num_command_line_args; ++i)
510 if (const char *arg = command_line_args[i]) {
511 if (strcmp(arg, "-o") == 0) {
512 ++i; // Also skip the matching argument.
513 continue;
514 }
515 if (strcmp(arg, "-emit-ast") == 0 ||
516 strcmp(arg, "-c") == 0 ||
517 strcmp(arg, "-fsyntax-only") == 0) {
518 continue;
519 }
520
521 // Keep the argument.
522 argv.push_back(arg);
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000523 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000524
Ted Kremenek139ba862009-10-22 00:03:57 +0000525 // Add the null terminator.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000526 argv.push_back(NULL);
527
Ted Kremenekfeb15e32009-10-26 22:14:08 +0000528 // Invoke 'clang'.
529 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
530 // on Unix or NUL (Windows).
Ted Kremenek379afec2009-10-22 03:24:01 +0000531 std::string ErrMsg;
Ted Kremenekc46e4632009-10-19 22:27:32 +0000532 const llvm::sys::Path *Redirects[] = { &DevNull, &DevNull, &DevNull, NULL };
Ted Kremenek379afec2009-10-22 03:24:01 +0000533 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
534 /* redirects */ !CXXIdx->getDisplayDiagnostics() ? &Redirects[0] : NULL,
535 /* secondsToWait */ 0, /* memoryLimits */ 0, &ErrMsg);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000536
Ted Kremenek0854d702009-11-10 19:18:52 +0000537 if (CXXIdx->getDisplayDiagnostics() && !ErrMsg.empty()) {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000538 llvm::errs() << "clang_createTranslationUnitFromSourceFile: " << ErrMsg
Daniel Dunbaracca7252009-11-30 20:42:49 +0000539 << '\n' << "Arguments: \n";
Ted Kremenek379afec2009-10-22 03:24:01 +0000540 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
Ted Kremenek779e5f42009-10-26 22:08:39 +0000541 I!=E; ++I) {
542 if (*I)
543 llvm::errs() << ' ' << *I << '\n';
544 }
545 llvm::errs() << '\n';
Ted Kremenek379afec2009-10-22 03:24:01 +0000546 }
Benjamin Kramer0829a832009-10-18 11:19:36 +0000547
Steve Naroff37b5ac22009-10-15 20:50:09 +0000548 // Finally, we create the translation unit from the ast file.
Steve Naroffe19944c2009-10-15 22:23:48 +0000549 ASTUnit *ATU = static_cast<ASTUnit *>(
Daniel Dunbaracca7252009-11-30 20:42:49 +0000550 clang_createTranslationUnit(CIdx, astTmpFile));
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000551 if (ATU)
552 ATU->unlinkTemporaryFile();
Steve Naroffe19944c2009-10-15 22:23:48 +0000553 return ATU;
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000554}
555
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000556void clang_disposeTranslationUnit(
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000557 CXTranslationUnit CTUnit)
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000558{
559 assert(CTUnit && "Passed null CXTranslationUnit");
560 delete static_cast<ASTUnit *>(CTUnit);
561}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000562
Steve Naroffef0cef62009-11-09 17:45:52 +0000563CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit)
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000564{
565 assert(CTUnit && "Passed null CXTranslationUnit");
Steve Naroff77accc12009-09-03 18:19:54 +0000566 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000567 return createCXString(CXXUnit->getOriginalSourceFileName().c_str(), true);
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000568}
Daniel Dunbar1eb79b52009-08-28 16:30:07 +0000569
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000570void clang_loadTranslationUnit(CXTranslationUnit CTUnit,
Steve Naroffc857ea42009-09-02 13:28:54 +0000571 CXTranslationUnitIterator callback,
572 CXClientData CData)
Steve Naroff600866c2009-08-27 19:51:58 +0000573{
Steve Naroff50398192009-08-28 15:28:48 +0000574 assert(CTUnit && "Passed null CXTranslationUnit");
575 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
576 ASTContext &Ctx = CXXUnit->getASTContext();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000577
578 TUVisitor DVisit(CTUnit, callback, CData,
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000579 CXXUnit->getOnlyLocalDecls()? 1 : Decl::MaxPCHLevel);
Steve Naroff50398192009-08-28 15:28:48 +0000580 DVisit.Visit(Ctx.getTranslationUnitDecl());
Steve Naroff600866c2009-08-27 19:51:58 +0000581}
582
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000583void clang_loadDeclaration(CXDecl Dcl,
584 CXDeclIterator callback,
Steve Naroffc857ea42009-09-02 13:28:54 +0000585 CXClientData CData)
Steve Naroff600866c2009-08-27 19:51:58 +0000586{
Steve Naroffc857ea42009-09-02 13:28:54 +0000587 assert(Dcl && "Passed null CXDecl");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000588
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000589 CDeclVisitor DVisit(Dcl, callback, CData,
590 static_cast<Decl *>(Dcl)->getPCHLevel());
Steve Naroffc857ea42009-09-02 13:28:54 +0000591 DVisit.Visit(static_cast<Decl *>(Dcl));
Steve Naroff600866c2009-08-27 19:51:58 +0000592}
593
Steve Naroff7e8f8182009-08-28 12:07:44 +0000594// Some notes on CXEntity:
595//
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000596// - Since the 'ordinary' namespace includes functions, data, typedefs,
597// ObjC interfaces, thecurrent algorithm is a bit naive (resulting in one
Steve Naroff7e8f8182009-08-28 12:07:44 +0000598// entity for 2 different types). For example:
599//
600// module1.m: @interface Foo @end Foo *x;
601// module2.m: void Foo(int);
602//
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000603// - Since the unique name spans translation units, static data/functions
Steve Naroff7e8f8182009-08-28 12:07:44 +0000604// within a CXTranslationUnit are *not* currently represented by entities.
605// As a result, there will be no entity for the following:
606//
607// module.m: static void Foo() { }
608//
609
610
Steve Naroff600866c2009-08-27 19:51:58 +0000611const char *clang_getDeclarationName(CXEntity)
612{
613 return "";
614}
615const char *clang_getURI(CXEntity)
616{
617 return "";
618}
619
620CXEntity clang_getEntity(const char *URI)
621{
622 return 0;
623}
624
625//
626// CXDecl Operations.
627//
Steve Naroff600866c2009-08-27 19:51:58 +0000628CXEntity clang_getEntityFromDecl(CXDecl)
629{
630 return 0;
631}
Steve Naroffef0cef62009-11-09 17:45:52 +0000632CXString clang_getDeclSpelling(CXDecl AnonDecl)
Steve Naroff600866c2009-08-27 19:51:58 +0000633{
Steve Naroff89922f82009-08-31 00:59:03 +0000634 assert(AnonDecl && "Passed null CXDecl");
635 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
Steve Naroffef0cef62009-11-09 17:45:52 +0000636
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000637 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
638 return createCXString(OMD->getSelector().getAsString().c_str(), true);
639
640 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
Steve Naroff0d69b8c2009-10-29 21:11:04 +0000641 // No, this isn't the same as the code below. getIdentifier() is non-virtual
642 // and returns different names. NamedDecl returns the class name and
643 // ObjCCategoryImplDecl returns the category name.
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000644 return createCXString(CIMP->getIdentifier()->getNameStart());
645
646 if (ND->getIdentifier())
647 return createCXString(ND->getIdentifier()->getNameStart());
648
649 return createCXString("");
Steve Naroff600866c2009-08-27 19:51:58 +0000650}
Steve Narofff334b4e2009-09-02 18:26:48 +0000651
Steve Naroff699a07d2009-09-25 21:32:34 +0000652unsigned clang_getDeclLine(CXDecl AnonDecl)
653{
654 assert(AnonDecl && "Passed null CXDecl");
655 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
656 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
657 return SourceMgr.getSpellingLineNumber(ND->getLocation());
658}
659
660unsigned clang_getDeclColumn(CXDecl AnonDecl)
661{
662 assert(AnonDecl && "Passed null CXDecl");
663 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
664 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Steve Naroff74165242009-09-25 22:15:54 +0000665 return SourceMgr.getSpellingColumnNumber(ND->getLocation());
Steve Naroff699a07d2009-09-25 21:32:34 +0000666}
667
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000668const char *clang_getDeclSource(CXDecl AnonDecl)
Steve Naroffee9405e2009-09-25 21:45:39 +0000669{
670 assert(AnonDecl && "Passed null CXDecl");
Steve Naroff88145032009-10-27 14:35:18 +0000671 FileEntry *FEnt = static_cast<FileEntry *>(clang_getDeclSourceFile(AnonDecl));
672 assert (FEnt && "Cannot find FileEntry for Decl");
673 return clang_getFileName(FEnt);
674}
675
676static const FileEntry *getFileEntryFromSourceLocation(SourceManager &SMgr,
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000677 SourceLocation SLoc)
Steve Naroff88145032009-10-27 14:35:18 +0000678{
679 FileID FID;
680 if (SLoc.isFileID())
681 FID = SMgr.getFileID(SLoc);
682 else
683 FID = SMgr.getDecomposedSpellingLoc(SLoc).first;
684 return SMgr.getFileEntryForID(FID);
685}
686
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000687CXFile clang_getDeclSourceFile(CXDecl AnonDecl)
Steve Naroff88145032009-10-27 14:35:18 +0000688{
689 assert(AnonDecl && "Passed null CXDecl");
Steve Naroffee9405e2009-09-25 21:45:39 +0000690 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
691 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Steve Naroff88145032009-10-27 14:35:18 +0000692 return (void *)getFileEntryFromSourceLocation(SourceMgr, ND->getLocation());
693}
694
695const char *clang_getFileName(CXFile SFile) {
696 assert(SFile && "Passed null CXFile");
697 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
698 return FEnt->getName();
699}
700
701time_t clang_getFileTime(CXFile SFile) {
702 assert(SFile && "Passed null CXFile");
703 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
704 return FEnt->getModificationTime();
Steve Naroffee9405e2009-09-25 21:45:39 +0000705}
706
Steve Naroffef0cef62009-11-09 17:45:52 +0000707CXString clang_getCursorSpelling(CXCursor C)
Steve Narofff334b4e2009-09-02 18:26:48 +0000708{
709 assert(C.decl && "CXCursor has null decl");
710 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
Steve Naroffef0cef62009-11-09 17:45:52 +0000711
Steve Narofff334b4e2009-09-02 18:26:48 +0000712 if (clang_isReference(C.kind)) {
713 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000714 case CXCursor_ObjCSuperClassRef: {
715 ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(ND);
716 assert(OID && "clang_getCursorLine(): Missing interface decl");
717 return createCXString(OID->getSuperClass()->getIdentifier()
718 ->getNameStart());
719 }
720 case CXCursor_ObjCClassRef: {
721 if (ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(ND))
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000722 return createCXString(OID->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +0000723
724 ObjCCategoryDecl *OCD = dyn_cast<ObjCCategoryDecl>(ND);
725 assert(OCD && "clang_getCursorLine(): Missing category decl");
726 return createCXString(OCD->getClassInterface()->getIdentifier()
727 ->getNameStart());
728 }
729 case CXCursor_ObjCProtocolRef: {
730 ObjCProtocolDecl *OID = dyn_cast<ObjCProtocolDecl>(ND);
731 assert(OID && "clang_getCursorLine(): Missing protocol decl");
732 return createCXString(OID->getIdentifier()->getNameStart());
733 }
734 case CXCursor_ObjCSelectorRef: {
735 ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(
736 static_cast<Stmt *>(C.stmt));
737 assert(OME && "clang_getCursorLine(): Missing message expr");
738 return createCXString(OME->getSelector().getAsString().c_str(), true);
739 }
740 case CXCursor_VarRef:
741 case CXCursor_FunctionRef:
742 case CXCursor_EnumConstantRef: {
743 DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(
744 static_cast<Stmt *>(C.stmt));
745 assert(DRE && "clang_getCursorLine(): Missing decl ref expr");
746 return createCXString(DRE->getDecl()->getIdentifier()->getNameStart());
747 }
748 default:
749 return createCXString("<not implemented>");
Steve Narofff334b4e2009-09-02 18:26:48 +0000750 }
751 }
752 return clang_getDeclSpelling(C.decl);
753}
754
755const char *clang_getCursorKindSpelling(enum CXCursorKind Kind)
Steve Naroff600866c2009-08-27 19:51:58 +0000756{
Steve Naroff89922f82009-08-31 00:59:03 +0000757 switch (Kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000758 case CXCursor_FunctionDecl: return "FunctionDecl";
759 case CXCursor_TypedefDecl: return "TypedefDecl";
760 case CXCursor_EnumDecl: return "EnumDecl";
761 case CXCursor_EnumConstantDecl: return "EnumConstantDecl";
762 case CXCursor_StructDecl: return "StructDecl";
763 case CXCursor_UnionDecl: return "UnionDecl";
764 case CXCursor_ClassDecl: return "ClassDecl";
765 case CXCursor_FieldDecl: return "FieldDecl";
766 case CXCursor_VarDecl: return "VarDecl";
767 case CXCursor_ParmDecl: return "ParmDecl";
768 case CXCursor_ObjCInterfaceDecl: return "ObjCInterfaceDecl";
769 case CXCursor_ObjCCategoryDecl: return "ObjCCategoryDecl";
770 case CXCursor_ObjCProtocolDecl: return "ObjCProtocolDecl";
771 case CXCursor_ObjCPropertyDecl: return "ObjCPropertyDecl";
772 case CXCursor_ObjCIvarDecl: return "ObjCIvarDecl";
773 case CXCursor_ObjCInstanceMethodDecl: return "ObjCInstanceMethodDecl";
774 case CXCursor_ObjCClassMethodDecl: return "ObjCClassMethodDecl";
775 case CXCursor_FunctionDefn: return "FunctionDefn";
776 case CXCursor_ObjCInstanceMethodDefn: return "ObjCInstanceMethodDefn";
777 case CXCursor_ObjCClassMethodDefn: return "ObjCClassMethodDefn";
778 case CXCursor_ObjCClassDefn: return "ObjCClassDefn";
779 case CXCursor_ObjCCategoryDefn: return "ObjCCategoryDefn";
780 case CXCursor_ObjCSuperClassRef: return "ObjCSuperClassRef";
781 case CXCursor_ObjCProtocolRef: return "ObjCProtocolRef";
782 case CXCursor_ObjCClassRef: return "ObjCClassRef";
783 case CXCursor_ObjCSelectorRef: return "ObjCSelectorRef";
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000784
Daniel Dunbaracca7252009-11-30 20:42:49 +0000785 case CXCursor_VarRef: return "VarRef";
786 case CXCursor_FunctionRef: return "FunctionRef";
787 case CXCursor_EnumConstantRef: return "EnumConstantRef";
788 case CXCursor_MemberRef: return "MemberRef";
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000789
Daniel Dunbaracca7252009-11-30 20:42:49 +0000790 case CXCursor_InvalidFile: return "InvalidFile";
791 case CXCursor_NoDeclFound: return "NoDeclFound";
792 case CXCursor_NotImplemented: return "NotImplemented";
793 default: return "<not implemented>";
Steve Naroff89922f82009-08-31 00:59:03 +0000794 }
Steve Naroff600866c2009-08-27 19:51:58 +0000795}
Steve Naroff89922f82009-08-31 00:59:03 +0000796
Steve Naroff9efa7672009-09-04 15:44:05 +0000797static enum CXCursorKind TranslateKind(Decl *D) {
798 switch (D->getKind()) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000799 case Decl::Function: return CXCursor_FunctionDecl;
800 case Decl::Typedef: return CXCursor_TypedefDecl;
801 case Decl::Enum: return CXCursor_EnumDecl;
802 case Decl::EnumConstant: return CXCursor_EnumConstantDecl;
803 case Decl::Record: return CXCursor_StructDecl; // FIXME: union/class
804 case Decl::Field: return CXCursor_FieldDecl;
805 case Decl::Var: return CXCursor_VarDecl;
806 case Decl::ParmVar: return CXCursor_ParmDecl;
807 case Decl::ObjCInterface: return CXCursor_ObjCInterfaceDecl;
808 case Decl::ObjCCategory: return CXCursor_ObjCCategoryDecl;
809 case Decl::ObjCProtocol: return CXCursor_ObjCProtocolDecl;
810 case Decl::ObjCMethod: {
811 ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D);
812 if (MD->isInstanceMethod())
813 return CXCursor_ObjCInstanceMethodDecl;
814 return CXCursor_ObjCClassMethodDecl;
815 }
816 default: break;
Steve Naroff9efa7672009-09-04 15:44:05 +0000817 }
Steve Naroff77128dd2009-09-15 20:25:34 +0000818 return CXCursor_NotImplemented;
Steve Naroff9efa7672009-09-04 15:44:05 +0000819}
Steve Naroff600866c2009-08-27 19:51:58 +0000820//
821// CXCursor Operations.
822//
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000823CXCursor clang_getCursor(CXTranslationUnit CTUnit, const char *source_name,
Steve Narofff96b5242009-10-28 20:44:47 +0000824 unsigned line, unsigned column)
Steve Naroff600866c2009-08-27 19:51:58 +0000825{
Steve Naroff9efa7672009-09-04 15:44:05 +0000826 assert(CTUnit && "Passed null CXTranslationUnit");
827 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000828
Steve Naroff9efa7672009-09-04 15:44:05 +0000829 FileManager &FMgr = CXXUnit->getFileManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000830 const FileEntry *File = FMgr.getFile(source_name,
831 source_name+strlen(source_name));
Steve Naroff77128dd2009-09-15 20:25:34 +0000832 if (!File) {
Steve Narofffb570422009-09-22 19:25:29 +0000833 CXCursor C = { CXCursor_InvalidFile, 0, 0 };
Steve Naroff77128dd2009-09-15 20:25:34 +0000834 return C;
835 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000836 SourceLocation SLoc =
Steve Naroff9efa7672009-09-04 15:44:05 +0000837 CXXUnit->getSourceManager().getLocation(File, line, column);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000838
Steve Narofff96b5242009-10-28 20:44:47 +0000839 ASTLocation LastLoc = CXXUnit->getLastASTLocation();
840
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000841 ASTLocation ALoc = ResolveLocationInAST(CXXUnit->getASTContext(), SLoc,
Steve Narofff96b5242009-10-28 20:44:47 +0000842 &LastLoc);
843 if (ALoc.isValid())
844 CXXUnit->setLastASTLocation(ALoc);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000845
Argyrios Kyrtzidisf4526e32009-09-29 19:44:27 +0000846 Decl *Dcl = ALoc.getParentDecl();
Argyrios Kyrtzidis05a76512009-09-29 19:45:58 +0000847 if (ALoc.isNamedRef())
848 Dcl = ALoc.AsNamedRef().ND;
Argyrios Kyrtzidisf4526e32009-09-29 19:44:27 +0000849 Stmt *Stm = ALoc.dyn_AsStmt();
Steve Naroff4ade6d62009-09-23 17:52:52 +0000850 if (Dcl) {
851 if (Stm) {
852 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Stm)) {
853 CXCursor C = { TranslateDeclRefExpr(DRE), Dcl, Stm };
854 return C;
855 } else if (ObjCMessageExpr *MExp = dyn_cast<ObjCMessageExpr>(Stm)) {
856 CXCursor C = { CXCursor_ObjCSelectorRef, Dcl, MExp };
857 return C;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000858 }
Steve Naroff4ade6d62009-09-23 17:52:52 +0000859 // Fall through...treat as a decl, not a ref.
860 }
Steve Naroff85e2db72009-10-01 00:31:07 +0000861 if (ALoc.isNamedRef()) {
862 if (isa<ObjCInterfaceDecl>(Dcl)) {
863 CXCursor C = { CXCursor_ObjCClassRef, Dcl, ALoc.getParentDecl() };
864 return C;
865 }
866 if (isa<ObjCProtocolDecl>(Dcl)) {
867 CXCursor C = { CXCursor_ObjCProtocolRef, Dcl, ALoc.getParentDecl() };
868 return C;
869 }
870 }
Daniel Dunbaracca7252009-11-30 20:42:49 +0000871 CXCursor C = { TranslateKind(Dcl), Dcl, 0 };
Steve Naroff77128dd2009-09-15 20:25:34 +0000872 return C;
873 }
Steve Narofffb570422009-09-22 19:25:29 +0000874 CXCursor C = { CXCursor_NoDeclFound, 0, 0 };
Steve Naroff9efa7672009-09-04 15:44:05 +0000875 return C;
Steve Naroff600866c2009-08-27 19:51:58 +0000876}
877
Ted Kremenek73885552009-11-17 19:28:59 +0000878CXCursor clang_getNullCursor(void) {
879 CXCursor C;
880 C.kind = CXCursor_InvalidFile;
881 C.decl = NULL;
882 C.stmt = NULL;
883 return C;
884}
885
886unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
887 return X.kind == Y.kind && X.decl == Y.decl && X.stmt == Y.stmt;
888}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000889
Steve Naroff77128dd2009-09-15 20:25:34 +0000890CXCursor clang_getCursorFromDecl(CXDecl AnonDecl)
891{
892 assert(AnonDecl && "Passed null CXDecl");
893 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000894
Steve Narofffb570422009-09-22 19:25:29 +0000895 CXCursor C = { TranslateKind(ND), ND, 0 };
Steve Naroff77128dd2009-09-15 20:25:34 +0000896 return C;
897}
898
899unsigned clang_isInvalid(enum CXCursorKind K)
900{
901 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
902}
903
Steve Naroff89922f82009-08-31 00:59:03 +0000904unsigned clang_isDeclaration(enum CXCursorKind K)
905{
906 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
907}
Steve Naroff2d4d6292009-08-31 14:26:51 +0000908
Steve Narofff334b4e2009-09-02 18:26:48 +0000909unsigned clang_isReference(enum CXCursorKind K)
910{
911 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
912}
913
914unsigned clang_isDefinition(enum CXCursorKind K)
915{
916 return K >= CXCursor_FirstDefn && K <= CXCursor_LastDefn;
917}
918
Steve Naroff9efa7672009-09-04 15:44:05 +0000919CXCursorKind clang_getCursorKind(CXCursor C)
920{
921 return C.kind;
922}
923
Steve Naroff699a07d2009-09-25 21:32:34 +0000924static Decl *getDeclFromExpr(Stmt *E) {
925 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
926 return RefExpr->getDecl();
927 if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
928 return ME->getMemberDecl();
929 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
930 return RE->getDecl();
931
932 if (CallExpr *CE = dyn_cast<CallExpr>(E))
933 return getDeclFromExpr(CE->getCallee());
934 if (CastExpr *CE = dyn_cast<CastExpr>(E))
935 return getDeclFromExpr(CE->getSubExpr());
936 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
937 return OME->getMethodDecl();
938
939 return 0;
940}
941
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000942CXDecl clang_getCursorDecl(CXCursor C)
Steve Naroff9efa7672009-09-04 15:44:05 +0000943{
Steve Naroff699a07d2009-09-25 21:32:34 +0000944 if (clang_isDeclaration(C.kind))
945 return C.decl;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000946
Steve Naroff699a07d2009-09-25 21:32:34 +0000947 if (clang_isReference(C.kind)) {
Steve Naroff85e2db72009-10-01 00:31:07 +0000948 if (C.stmt) {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000949 if (C.kind == CXCursor_ObjCClassRef ||
Steve Narofff9adf8f2009-10-05 17:58:19 +0000950 C.kind == CXCursor_ObjCProtocolRef)
Steve Naroff85e2db72009-10-01 00:31:07 +0000951 return static_cast<Stmt *>(C.stmt);
952 else
953 return getDeclFromExpr(static_cast<Stmt *>(C.stmt));
954 } else
Steve Naroff699a07d2009-09-25 21:32:34 +0000955 return C.decl;
956 }
957 return 0;
Steve Naroff9efa7672009-09-04 15:44:05 +0000958}
959
Steve Naroff2d4d6292009-08-31 14:26:51 +0000960unsigned clang_getCursorLine(CXCursor C)
Steve Naroff600866c2009-08-27 19:51:58 +0000961{
Steve Naroff2d4d6292009-08-31 14:26:51 +0000962 assert(C.decl && "CXCursor has null decl");
963 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
Steve Naroff2d4d6292009-08-31 14:26:51 +0000964 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000965
Steve Narofff334b4e2009-09-02 18:26:48 +0000966 SourceLocation SLoc = getLocationFromCursor(C, SourceMgr, ND);
Steve Naroff2d4d6292009-08-31 14:26:51 +0000967 return SourceMgr.getSpellingLineNumber(SLoc);
Steve Naroff600866c2009-08-27 19:51:58 +0000968}
Steve Narofff334b4e2009-09-02 18:26:48 +0000969
Steve Naroffef0cef62009-11-09 17:45:52 +0000970const char *clang_getCString(CXString string) {
971 return string.Spelling;
972}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000973
Steve Naroffef0cef62009-11-09 17:45:52 +0000974void clang_disposeString(CXString string) {
Benjamin Kramer858e5de2009-11-09 18:24:53 +0000975 if (string.MustFreeString)
976 free((void*)string.Spelling);
Steve Naroffef0cef62009-11-09 17:45:52 +0000977}
978
Steve Naroff2d4d6292009-08-31 14:26:51 +0000979unsigned clang_getCursorColumn(CXCursor C)
Steve Naroff600866c2009-08-27 19:51:58 +0000980{
Steve Naroff2d4d6292009-08-31 14:26:51 +0000981 assert(C.decl && "CXCursor has null decl");
982 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
Steve Naroff2d4d6292009-08-31 14:26:51 +0000983 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000984
Steve Narofff334b4e2009-09-02 18:26:48 +0000985 SourceLocation SLoc = getLocationFromCursor(C, SourceMgr, ND);
Steve Naroff2d4d6292009-08-31 14:26:51 +0000986 return SourceMgr.getSpellingColumnNumber(SLoc);
Steve Naroff600866c2009-08-27 19:51:58 +0000987}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000988const char *clang_getCursorSource(CXCursor C)
Steve Naroff600866c2009-08-27 19:51:58 +0000989{
Steve Naroff2d4d6292009-08-31 14:26:51 +0000990 assert(C.decl && "CXCursor has null decl");
991 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
Steve Naroff2d4d6292009-08-31 14:26:51 +0000992 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000993
Steve Narofff334b4e2009-09-02 18:26:48 +0000994 SourceLocation SLoc = getLocationFromCursor(C, SourceMgr, ND);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000995
Ted Kremenek9298cfc2009-11-17 05:31:58 +0000996 if (SLoc.isFileID()) {
997 const char *bufferName = SourceMgr.getBufferName(SLoc);
998 return bufferName[0] == '<' ? NULL : bufferName;
999 }
Douglas Gregor02465752009-10-16 21:24:31 +00001000
1001 // Retrieve the file in which the macro was instantiated, then provide that
1002 // buffer name.
1003 // FIXME: Do we want to give specific macro-instantiation information?
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001004 const llvm::MemoryBuffer *Buffer
Douglas Gregor02465752009-10-16 21:24:31 +00001005 = SourceMgr.getBuffer(SourceMgr.getDecomposedSpellingLoc(SLoc).first);
1006 if (!Buffer)
1007 return 0;
1008
1009 return Buffer->getBufferIdentifier();
Steve Naroff600866c2009-08-27 19:51:58 +00001010}
1011
Steve Naroff88145032009-10-27 14:35:18 +00001012CXFile clang_getCursorSourceFile(CXCursor C)
1013{
1014 assert(C.decl && "CXCursor has null decl");
1015 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
1016 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001017
Steve Naroff88145032009-10-27 14:35:18 +00001018 return (void *)getFileEntryFromSourceLocation(SourceMgr,
Daniel Dunbaracca7252009-11-30 20:42:49 +00001019 getLocationFromCursor(C,SourceMgr, ND));
Steve Naroff88145032009-10-27 14:35:18 +00001020}
1021
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001022void clang_getDefinitionSpellingAndExtent(CXCursor C,
Steve Naroff4ade6d62009-09-23 17:52:52 +00001023 const char **startBuf,
1024 const char **endBuf,
1025 unsigned *startLine,
1026 unsigned *startColumn,
1027 unsigned *endLine,
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001028 unsigned *endColumn)
Steve Naroff4ade6d62009-09-23 17:52:52 +00001029{
1030 assert(C.decl && "CXCursor has null decl");
1031 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
1032 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
1033 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001034
Steve Naroff4ade6d62009-09-23 17:52:52 +00001035 SourceManager &SM = FD->getASTContext().getSourceManager();
1036 *startBuf = SM.getCharacterData(Body->getLBracLoc());
1037 *endBuf = SM.getCharacterData(Body->getRBracLoc());
1038 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
1039 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
1040 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
1041 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
1042}
1043
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001044enum CXCompletionChunkKind
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001045clang_getCompletionChunkKind(CXCompletionString completion_string,
1046 unsigned chunk_number) {
1047 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1048 if (!CCStr || chunk_number >= CCStr->size())
1049 return CXCompletionChunk_Text;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001050
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001051 switch ((*CCStr)[chunk_number].Kind) {
1052 case CodeCompletionString::CK_TypedText:
1053 return CXCompletionChunk_TypedText;
1054 case CodeCompletionString::CK_Text:
1055 return CXCompletionChunk_Text;
1056 case CodeCompletionString::CK_Optional:
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001057 return CXCompletionChunk_Optional;
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001058 case CodeCompletionString::CK_Placeholder:
1059 return CXCompletionChunk_Placeholder;
1060 case CodeCompletionString::CK_Informative:
1061 return CXCompletionChunk_Informative;
1062 case CodeCompletionString::CK_CurrentParameter:
1063 return CXCompletionChunk_CurrentParameter;
1064 case CodeCompletionString::CK_LeftParen:
1065 return CXCompletionChunk_LeftParen;
1066 case CodeCompletionString::CK_RightParen:
1067 return CXCompletionChunk_RightParen;
1068 case CodeCompletionString::CK_LeftBracket:
1069 return CXCompletionChunk_LeftBracket;
1070 case CodeCompletionString::CK_RightBracket:
1071 return CXCompletionChunk_RightBracket;
1072 case CodeCompletionString::CK_LeftBrace:
1073 return CXCompletionChunk_LeftBrace;
1074 case CodeCompletionString::CK_RightBrace:
1075 return CXCompletionChunk_RightBrace;
1076 case CodeCompletionString::CK_LeftAngle:
1077 return CXCompletionChunk_LeftAngle;
1078 case CodeCompletionString::CK_RightAngle:
1079 return CXCompletionChunk_RightAngle;
1080 case CodeCompletionString::CK_Comma:
1081 return CXCompletionChunk_Comma;
1082 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001083
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001084 // Should be unreachable, but let's be careful.
1085 return CXCompletionChunk_Text;
1086}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001087
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001088const char *clang_getCompletionChunkText(CXCompletionString completion_string,
1089 unsigned chunk_number) {
1090 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1091 if (!CCStr || chunk_number >= CCStr->size())
1092 return 0;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001093
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001094 switch ((*CCStr)[chunk_number].Kind) {
1095 case CodeCompletionString::CK_TypedText:
1096 case CodeCompletionString::CK_Text:
1097 case CodeCompletionString::CK_Placeholder:
1098 case CodeCompletionString::CK_CurrentParameter:
1099 case CodeCompletionString::CK_Informative:
1100 case CodeCompletionString::CK_LeftParen:
1101 case CodeCompletionString::CK_RightParen:
1102 case CodeCompletionString::CK_LeftBracket:
1103 case CodeCompletionString::CK_RightBracket:
1104 case CodeCompletionString::CK_LeftBrace:
1105 case CodeCompletionString::CK_RightBrace:
1106 case CodeCompletionString::CK_LeftAngle:
1107 case CodeCompletionString::CK_RightAngle:
1108 case CodeCompletionString::CK_Comma:
1109 return (*CCStr)[chunk_number].Text;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001110
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001111 case CodeCompletionString::CK_Optional:
1112 // Note: treated as an empty text block.
1113 return 0;
1114 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001115
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001116 // Should be unreachable, but let's be careful.
1117 return 0;
1118}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001119
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001120CXCompletionString
1121clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
1122 unsigned chunk_number) {
1123 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1124 if (!CCStr || chunk_number >= CCStr->size())
1125 return 0;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001126
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001127 switch ((*CCStr)[chunk_number].Kind) {
1128 case CodeCompletionString::CK_TypedText:
1129 case CodeCompletionString::CK_Text:
1130 case CodeCompletionString::CK_Placeholder:
1131 case CodeCompletionString::CK_CurrentParameter:
1132 case CodeCompletionString::CK_Informative:
1133 case CodeCompletionString::CK_LeftParen:
1134 case CodeCompletionString::CK_RightParen:
1135 case CodeCompletionString::CK_LeftBracket:
1136 case CodeCompletionString::CK_RightBracket:
1137 case CodeCompletionString::CK_LeftBrace:
1138 case CodeCompletionString::CK_RightBrace:
1139 case CodeCompletionString::CK_LeftAngle:
1140 case CodeCompletionString::CK_RightAngle:
1141 case CodeCompletionString::CK_Comma:
1142 return 0;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001143
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001144 case CodeCompletionString::CK_Optional:
1145 // Note: treated as an empty text block.
1146 return (*CCStr)[chunk_number].Optional;
1147 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001148
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001149 // Should be unreachable, but let's be careful.
1150 return 0;
1151}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001152
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001153unsigned clang_getNumCompletionChunks(CXCompletionString completion_string) {
1154 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1155 return CCStr? CCStr->size() : 0;
1156}
Steve Naroff4ade6d62009-09-23 17:52:52 +00001157
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001158static CXCursorKind parseResultKind(llvm::StringRef Str) {
1159 return llvm::StringSwitch<CXCursorKind>(Str)
1160 .Case("Typedef", CXCursor_TypedefDecl)
1161 .Case("Struct", CXCursor_StructDecl)
1162 .Case("Union", CXCursor_UnionDecl)
1163 .Case("Class", CXCursor_ClassDecl)
Douglas Gregorff4393c2009-11-09 21:35:27 +00001164 .Case("Enum", CXCursor_EnumDecl)
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001165 .Case("Field", CXCursor_FieldDecl)
1166 .Case("EnumConstant", CXCursor_EnumConstantDecl)
1167 .Case("Function", CXCursor_FunctionDecl)
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001168 // FIXME: Hacks here to make C++ member functions look like C functions
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001169 .Case("CXXMethod", CXCursor_FunctionDecl)
1170 .Case("CXXConstructor", CXCursor_FunctionDecl)
1171 .Case("CXXDestructor", CXCursor_FunctionDecl)
1172 .Case("CXXConversion", CXCursor_FunctionDecl)
1173 .Case("Var", CXCursor_VarDecl)
1174 .Case("ParmVar", CXCursor_ParmDecl)
1175 .Case("ObjCInterface", CXCursor_ObjCInterfaceDecl)
1176 .Case("ObjCCategory", CXCursor_ObjCCategoryDecl)
1177 .Case("ObjCProtocol", CXCursor_ObjCProtocolDecl)
1178 .Case("ObjCProperty", CXCursor_ObjCPropertyDecl)
1179 .Case("ObjCIvar", CXCursor_ObjCIvarDecl)
1180 .Case("ObjCInstanceMethod", CXCursor_ObjCInstanceMethodDecl)
1181 .Case("ObjCClassMethod", CXCursor_ObjCClassMethodDecl)
1182 .Default(CXCursor_NotImplemented);
1183}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001184
1185void clang_codeComplete(CXIndex CIdx,
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001186 const char *source_filename,
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001187 int num_command_line_args,
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001188 const char **command_line_args,
1189 const char *complete_filename,
1190 unsigned complete_line,
1191 unsigned complete_column,
1192 CXCompletionIterator completion_iterator,
1193 CXClientData client_data) {
1194 // The indexer, which is mainly used to determine where diagnostics go.
1195 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001196
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001197 // Build up the arguments for invoking 'clang'.
1198 std::vector<const char *> argv;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001199
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001200 // First add the complete path to the 'clang' executable.
1201 llvm::sys::Path ClangPath = CXXIdx->getClangPath();
1202 argv.push_back(ClangPath.c_str());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001203
1204 // Add the '-fsyntax-only' argument so that we only perform a basic
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001205 // syntax check of the code.
1206 argv.push_back("-fsyntax-only");
1207
1208 // Add the appropriate '-code-completion-at=file:line:column' argument
1209 // to perform code completion, with an "-Xclang" preceding it.
1210 std::string code_complete_at;
1211 code_complete_at += "-code-completion-at=";
1212 code_complete_at += complete_filename;
1213 code_complete_at += ":";
1214 code_complete_at += llvm::utostr(complete_line);
1215 code_complete_at += ":";
1216 code_complete_at += llvm::utostr(complete_column);
1217 argv.push_back("-Xclang");
1218 argv.push_back(code_complete_at.c_str());
1219 argv.push_back("-Xclang");
Daniel Dunbar4db166b2009-11-19 05:32:09 +00001220 argv.push_back("-no-code-completion-debug-printer");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001221
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001222 // Add the source file name (FIXME: later, we'll want to build temporary
1223 // file from the buffer, or just feed the source text via standard input).
Ted Kremenek4633d1b2009-11-17 18:18:02 +00001224 if (source_filename)
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001225 argv.push_back(source_filename);
1226
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001227 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
1228 for (int i = 0; i < num_command_line_args; ++i)
1229 if (const char *arg = command_line_args[i]) {
1230 if (strcmp(arg, "-o") == 0) {
1231 ++i; // Also skip the matching argument.
1232 continue;
1233 }
1234 if (strcmp(arg, "-emit-ast") == 0 ||
1235 strcmp(arg, "-c") == 0 ||
1236 strcmp(arg, "-fsyntax-only") == 0) {
1237 continue;
1238 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001239
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001240 // Keep the argument.
1241 argv.push_back(arg);
1242 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001243
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001244 // Add the null terminator.
1245 argv.push_back(NULL);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001246
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001247 // Generate a temporary name for the AST file.
1248 char tmpFile[L_tmpnam];
1249 char *tmpFileName = tmpnam(tmpFile);
1250 llvm::sys::Path ResultsFile(tmpFileName);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001251
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001252 // Invoke 'clang'.
1253 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
1254 // on Unix or NUL (Windows).
1255 std::string ErrMsg;
1256 const llvm::sys::Path *Redirects[] = { &DevNull, &ResultsFile, &DevNull, 0 };
1257 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
1258 /* redirects */ &Redirects[0],
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001259 /* secondsToWait */ 0,
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001260 /* memoryLimits */ 0, &ErrMsg);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001261
Ted Kremenek0854d702009-11-10 19:18:52 +00001262 if (CXXIdx->getDisplayDiagnostics() && !ErrMsg.empty()) {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001263 llvm::errs() << "clang_codeComplete: " << ErrMsg
Daniel Dunbaracca7252009-11-30 20:42:49 +00001264 << '\n' << "Arguments: \n";
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001265 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
1266 I!=E; ++I) {
1267 if (*I)
1268 llvm::errs() << ' ' << *I << '\n';
1269 }
1270 llvm::errs() << '\n';
1271 }
1272
1273 // Parse the resulting source file to find code-completion results.
1274 using llvm::MemoryBuffer;
1275 using llvm::StringRef;
1276 if (MemoryBuffer *F = MemoryBuffer::getFile(ResultsFile.c_str())) {
1277 StringRef Buffer = F->getBuffer();
1278 do {
1279 StringRef::size_type CompletionIdx = Buffer.find("COMPLETION:");
1280 StringRef::size_type OverloadIdx = Buffer.find("OVERLOAD:");
1281 if (CompletionIdx == StringRef::npos && OverloadIdx == StringRef::npos)
1282 break;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001283
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001284 if (OverloadIdx < CompletionIdx) {
1285 // Parse an overload result.
1286 Buffer = Buffer.substr(OverloadIdx);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001287
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001288 // Skip past the OVERLOAD:
1289 Buffer = Buffer.substr(Buffer.find(':') + 1);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001290
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001291 // Find the entire completion string.
1292 StringRef::size_type EOL = Buffer.find_first_of("\n\r");
1293 if (EOL == StringRef::npos)
1294 continue;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001295
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001296 StringRef Line = Buffer.substr(0, EOL);
1297 Buffer = Buffer.substr(EOL + 1);
1298 CodeCompletionString *CCStr = CodeCompletionString::Deserialize(Line);
1299 if (!CCStr || CCStr->empty())
1300 continue;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001301
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001302 // Vend the code-completion result to the caller.
1303 CXCompletionResult Result;
1304 Result.CursorKind = CXCursor_NotImplemented;
1305 Result.CompletionString = CCStr;
1306 if (completion_iterator)
1307 completion_iterator(&Result, client_data);
1308 delete CCStr;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001309
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001310 continue;
1311 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001312
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001313 // Parse a completion result.
1314 Buffer = Buffer.substr(CompletionIdx);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001315
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001316 // Skip past the COMPLETION:
1317 Buffer = Buffer.substr(Buffer.find(':') + 1);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001318
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001319 // Get the rank
1320 unsigned Rank = 0;
1321 StringRef::size_type AfterRank = Buffer.find(':');
1322 Buffer.substr(0, AfterRank).getAsInteger(10, Rank);
1323 Buffer = Buffer.substr(AfterRank + 1);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001324
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001325 // Get the kind of result.
1326 StringRef::size_type AfterKind = Buffer.find(':');
1327 StringRef Kind = Buffer.substr(0, AfterKind);
1328 Buffer = Buffer.substr(AfterKind + 1);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001329
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001330 // Skip over any whitespace.
1331 Buffer = Buffer.substr(Buffer.find_first_not_of(" \t"));
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001332
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001333 // Find the entire completion string.
1334 StringRef::size_type EOL = Buffer.find_first_of("\n\r");
1335 if (EOL == StringRef::npos)
1336 continue;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001337
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001338 StringRef Line = Buffer.substr(0, EOL);
1339 Buffer = Buffer.substr(EOL + 1);
1340 CodeCompletionString *CCStr = CodeCompletionString::Deserialize(Line);
1341 if (!CCStr || CCStr->empty())
1342 continue;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001343
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001344 // Vend the code-completion result to the caller.
1345 CXCompletionResult Result;
1346 Result.CursorKind = parseResultKind(Kind);
1347 Result.CompletionString = CCStr;
1348 if (completion_iterator)
1349 completion_iterator(&Result, client_data);
1350 delete CCStr;
1351 } while (true);
1352 delete F;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001353 }
1354
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001355 ResultsFile.eraseFromDisk();
1356}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001357
Steve Naroff600866c2009-08-27 19:51:58 +00001358} // end extern "C"