blob: 12c3935ca12e71b5a3f4fae0af4b1e7dddbecb7b [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"
Daniel Dunbar5262fda2009-12-03 01:45:44 +000026#include "clang/Frontend/CompilerInstance.h"
Douglas Gregor0c8296d2009-11-07 00:00:49 +000027#include "llvm/ADT/StringExtras.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 Dunbar5262fda2009-12-03 01:45:44 +0000295 IgnoreDiagnosticsClient IgnoreDiagClient;
296 llvm::OwningPtr<Diagnostic> TextDiags;
297 Diagnostic IgnoreDiags;
298 bool UseExternalASTGeneration;
299 bool OnlyLocalDecls;
300 bool DisplayDiagnostics;
301
302 llvm::sys::Path ClangPath;
303
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000304public:
305 explicit CIndexer(Program *prog) : Indexer(*prog),
Daniel Dunbar5262fda2009-12-03 01:45:44 +0000306 IgnoreDiags(&IgnoreDiagClient),
307 UseExternalASTGeneration(false),
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000308 OnlyLocalDecls(false),
Daniel Dunbar5262fda2009-12-03 01:45:44 +0000309 DisplayDiagnostics(false) {
310 TextDiags.reset(
311 CompilerInstance::createDiagnostics(DiagnosticOptions(), 0, 0));
312 }
Ted Kremenekdff76892009-10-17 06:21:47 +0000313
314 virtual ~CIndexer() { delete &getProgram(); }
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000315
316 /// \brief Whether we only want to see "local" declarations (that did not
317 /// come from a previous precompiled header). If false, we want to see all
318 /// declarations.
319 bool getOnlyLocalDecls() const { return OnlyLocalDecls; }
320 void setOnlyLocalDecls(bool Local = true) { OnlyLocalDecls = Local; }
Benjamin Kramer96707622009-10-18 11:10:55 +0000321
Daniel Dunbar5262fda2009-12-03 01:45:44 +0000322 bool getDisplayDiagnostics() const { return DisplayDiagnostics; }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000323 void setDisplayDiagnostics(bool Display = true) {
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000324 DisplayDiagnostics = Display;
325 }
Daniel Dunbar5262fda2009-12-03 01:45:44 +0000326
Daniel Dunbar8506dde2009-12-03 01:54:28 +0000327 bool getUseExternalASTGeneration() const { return UseExternalASTGeneration; }
328 void setUseExternalASTGeneration(bool Value) {
329 UseExternalASTGeneration = Value;
330 }
331
Daniel Dunbar5262fda2009-12-03 01:45:44 +0000332 Diagnostic &getDiags() {
333 return DisplayDiagnostics ? *TextDiags : IgnoreDiags;
334 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000335
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000336 /// \brief Get the path of the clang binary.
Benjamin Kramerc5a9e952009-10-19 10:20:24 +0000337 const llvm::sys::Path& getClangPath();
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000338};
Steve Naroff89922f82009-08-31 00:59:03 +0000339
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000340const llvm::sys::Path& CIndexer::getClangPath() {
341 // Did we already compute the path?
342 if (!ClangPath.empty())
343 return ClangPath;
344
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000345 // Find the location where this library lives (libCIndex.dylib).
Benjamin Kramer20d75812009-10-18 16:13:48 +0000346#ifdef LLVM_ON_WIN32
347 MEMORY_BASIC_INFORMATION mbi;
348 char path[MAX_PATH];
Benjamin Krameredcd8282009-10-18 16:20:58 +0000349 VirtualQuery((void *)(uintptr_t)clang_createTranslationUnit, &mbi,
Benjamin Kramer20d75812009-10-18 16:13:48 +0000350 sizeof(mbi));
351 GetModuleFileNameA((HINSTANCE)mbi.AllocationBase, path, MAX_PATH);
352
353 llvm::sys::Path CIndexPath(path);
John Thompson6a6742a2009-11-11 23:11:14 +0000354
355 CIndexPath.eraseComponent();
356 CIndexPath.appendComponent("clang");
357 CIndexPath.appendSuffix("exe");
358 CIndexPath.makeAbsolute();
Benjamin Kramer20d75812009-10-18 16:13:48 +0000359#else
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000360 // This silly cast below avoids a C++ warning.
361 Dl_info info;
362 if (dladdr((void *)(uintptr_t)clang_createTranslationUnit, &info) == 0)
363 assert(0 && "Call to dladdr() failed");
364
365 llvm::sys::Path CIndexPath(info.dli_fname);
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000366
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000367 // We now have the CIndex directory, locate clang relative to it.
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000368 CIndexPath.eraseComponent();
369 CIndexPath.eraseComponent();
370 CIndexPath.appendComponent("bin");
371 CIndexPath.appendComponent("clang");
John Thompson6a6742a2009-11-11 23:11:14 +0000372#endif
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000373
374 // Cache our result.
375 ClangPath = CIndexPath;
376 return ClangPath;
377}
378
379}
380
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000381static SourceLocation getLocationFromCursor(CXCursor C,
Daniel Dunbarc6190332009-11-08 04:13:53 +0000382 SourceManager &SourceMgr,
383 NamedDecl *ND) {
384 if (clang_isReference(C.kind)) {
385 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000386 case CXCursor_ObjCClassRef: {
387 if (isa<ObjCInterfaceDecl>(ND)) {
388 // FIXME: This is a hack (storing the parent decl in the stmt slot).
389 NamedDecl *parentDecl = static_cast<NamedDecl *>(C.stmt);
390 return parentDecl->getLocation();
Daniel Dunbarc6190332009-11-08 04:13:53 +0000391 }
Daniel Dunbaracca7252009-11-30 20:42:49 +0000392 ObjCCategoryDecl *OID = dyn_cast<ObjCCategoryDecl>(ND);
393 assert(OID && "clang_getCursorLine(): Missing category decl");
394 return OID->getClassInterface()->getLocation();
395 }
396 case CXCursor_ObjCSuperClassRef: {
397 ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(ND);
398 assert(OID && "clang_getCursorLine(): Missing interface decl");
399 return OID->getSuperClassLoc();
400 }
401 case CXCursor_ObjCProtocolRef: {
402 ObjCProtocolDecl *OID = dyn_cast<ObjCProtocolDecl>(ND);
403 assert(OID && "clang_getCursorLine(): Missing protocol decl");
404 return OID->getLocation();
405 }
406 case CXCursor_ObjCSelectorRef: {
407 ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(
408 static_cast<Stmt *>(C.stmt));
409 assert(OME && "clang_getCursorLine(): Missing message expr");
410 return OME->getLeftLoc(); /* FIXME: should be a range */
411 }
412 case CXCursor_VarRef:
413 case CXCursor_FunctionRef:
414 case CXCursor_EnumConstantRef: {
415 DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(
416 static_cast<Stmt *>(C.stmt));
417 assert(DRE && "clang_getCursorLine(): Missing decl ref expr");
418 return DRE->getLocation();
419 }
420 default:
421 return SourceLocation();
Daniel Dunbarc6190332009-11-08 04:13:53 +0000422 }
423 } else { // We have a declaration or a definition.
424 SourceLocation SLoc;
425 switch (ND->getKind()) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000426 case Decl::ObjCInterface: {
427 SLoc = dyn_cast<ObjCInterfaceDecl>(ND)->getClassLoc();
428 break;
429 }
430 case Decl::ObjCProtocol: {
431 SLoc = ND->getLocation(); /* FIXME: need to get the name location. */
432 break;
433 }
434 default: {
435 SLoc = ND->getLocation();
436 break;
437 }
Daniel Dunbarc6190332009-11-08 04:13:53 +0000438 }
439 if (SLoc.isInvalid())
440 return SourceLocation();
441 return SourceMgr.getSpellingLoc(SLoc); // handles macro instantiations.
442 }
443}
444
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000445static CXString createCXString(const char *String, bool DupString = false) {
446 CXString Str;
447 if (DupString) {
448 Str.Spelling = strdup(String);
449 Str.MustFreeString = 1;
450 } else {
451 Str.Spelling = String;
452 Str.MustFreeString = 0;
453 }
454 return Str;
455}
456
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000457extern "C" {
458
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000459CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000460 int displayDiagnostics) {
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000461 CIndexer *CIdxr = new CIndexer(new Program());
462 if (excludeDeclarationsFromPCH)
463 CIdxr->setOnlyLocalDecls();
464 if (displayDiagnostics)
465 CIdxr->setDisplayDiagnostics();
466 return CIdxr;
Steve Naroff600866c2009-08-27 19:51:58 +0000467}
468
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000469void clang_disposeIndex(CXIndex CIdx) {
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000470 assert(CIdx && "Passed null CXIndex");
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000471 delete static_cast<CIndexer *>(CIdx);
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000472}
473
Daniel Dunbar8506dde2009-12-03 01:54:28 +0000474void clang_setUseExternalASTGeneration(CXIndex CIdx, int value) {
475 assert(CIdx && "Passed null CXIndex");
476 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
477 CXXIdx->setUseExternalASTGeneration(value);
478}
479
Steve Naroff50398192009-08-28 15:28:48 +0000480// FIXME: need to pass back error info.
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000481CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
482 const char *ast_filename) {
Steve Naroff50398192009-08-28 15:28:48 +0000483 assert(CIdx && "Passed null CXIndex");
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000484 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000485
Daniel Dunbar5262fda2009-12-03 01:45:44 +0000486 return ASTUnit::LoadFromPCHFile(ast_filename, CXXIdx->getDiags(),
487 CXXIdx->getOnlyLocalDecls(),
488 /* UseBumpAllocator = */ true);
Steve Naroff600866c2009-08-27 19:51:58 +0000489}
490
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000491CXTranslationUnit
492clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
493 const char *source_filename,
494 int num_command_line_args,
495 const char **command_line_args) {
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000496 assert(CIdx && "Passed null CXIndex");
497 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
498
Daniel Dunbar8506dde2009-12-03 01:54:28 +0000499 if (!CXXIdx->getUseExternalASTGeneration()) {
500 llvm::SmallVector<const char *, 16> Args;
501
502 // The 'source_filename' argument is optional. If the caller does not
503 // specify it then it is assumed that the source file is specified
504 // in the actual argument list.
505 if (source_filename)
506 Args.push_back(source_filename);
507 Args.insert(Args.end(), command_line_args,
508 command_line_args + num_command_line_args);
509
510 void *MainAddr = (void *)(uintptr_t)clang_createTranslationUnit;
511 return ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(),
512 CXXIdx->getDiags(), "<clang>", MainAddr,
513 CXXIdx->getOnlyLocalDecls(),
514 /* UseBumpAllocator = */ true);
515 }
516
Ted Kremenek139ba862009-10-22 00:03:57 +0000517 // Build up the arguments for invoking 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000518 std::vector<const char *> argv;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000519
Ted Kremenek139ba862009-10-22 00:03:57 +0000520 // First add the complete path to the 'clang' executable.
521 llvm::sys::Path ClangPath = static_cast<CIndexer *>(CIdx)->getClangPath();
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000522 argv.push_back(ClangPath.c_str());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000523
Ted Kremenek139ba862009-10-22 00:03:57 +0000524 // Add the '-emit-ast' option as our execution mode for 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000525 argv.push_back("-emit-ast");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000526
Ted Kremenek139ba862009-10-22 00:03:57 +0000527 // The 'source_filename' argument is optional. If the caller does not
528 // specify it then it is assumed that the source file is specified
529 // in the actual argument list.
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000530 if (source_filename)
531 argv.push_back(source_filename);
Ted Kremenek139ba862009-10-22 00:03:57 +0000532
Steve Naroff37b5ac22009-10-15 20:50:09 +0000533 // Generate a temporary name for the AST file.
Ted Kremenek139ba862009-10-22 00:03:57 +0000534 argv.push_back("-o");
Steve Naroff37b5ac22009-10-15 20:50:09 +0000535 char astTmpFile[L_tmpnam];
Ted Kremenek74cd0692009-10-15 23:21:22 +0000536 argv.push_back(tmpnam(astTmpFile));
Ted Kremenek139ba862009-10-22 00:03:57 +0000537
538 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
539 for (int i = 0; i < num_command_line_args; ++i)
540 if (const char *arg = command_line_args[i]) {
541 if (strcmp(arg, "-o") == 0) {
542 ++i; // Also skip the matching argument.
543 continue;
544 }
545 if (strcmp(arg, "-emit-ast") == 0 ||
546 strcmp(arg, "-c") == 0 ||
547 strcmp(arg, "-fsyntax-only") == 0) {
548 continue;
549 }
550
551 // Keep the argument.
552 argv.push_back(arg);
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000553 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000554
Ted Kremenek139ba862009-10-22 00:03:57 +0000555 // Add the null terminator.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000556 argv.push_back(NULL);
557
Ted Kremenekfeb15e32009-10-26 22:14:08 +0000558 // Invoke 'clang'.
559 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
560 // on Unix or NUL (Windows).
Ted Kremenek379afec2009-10-22 03:24:01 +0000561 std::string ErrMsg;
Ted Kremenekc46e4632009-10-19 22:27:32 +0000562 const llvm::sys::Path *Redirects[] = { &DevNull, &DevNull, &DevNull, NULL };
Ted Kremenek379afec2009-10-22 03:24:01 +0000563 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
564 /* redirects */ !CXXIdx->getDisplayDiagnostics() ? &Redirects[0] : NULL,
565 /* secondsToWait */ 0, /* memoryLimits */ 0, &ErrMsg);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000566
Ted Kremenek0854d702009-11-10 19:18:52 +0000567 if (CXXIdx->getDisplayDiagnostics() && !ErrMsg.empty()) {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000568 llvm::errs() << "clang_createTranslationUnitFromSourceFile: " << ErrMsg
Daniel Dunbaracca7252009-11-30 20:42:49 +0000569 << '\n' << "Arguments: \n";
Ted Kremenek379afec2009-10-22 03:24:01 +0000570 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
Ted Kremenek779e5f42009-10-26 22:08:39 +0000571 I!=E; ++I) {
572 if (*I)
573 llvm::errs() << ' ' << *I << '\n';
574 }
575 llvm::errs() << '\n';
Ted Kremenek379afec2009-10-22 03:24:01 +0000576 }
Benjamin Kramer0829a832009-10-18 11:19:36 +0000577
Steve Naroff37b5ac22009-10-15 20:50:09 +0000578 // Finally, we create the translation unit from the ast file.
Steve Naroffe19944c2009-10-15 22:23:48 +0000579 ASTUnit *ATU = static_cast<ASTUnit *>(
Daniel Dunbaracca7252009-11-30 20:42:49 +0000580 clang_createTranslationUnit(CIdx, astTmpFile));
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000581 if (ATU)
582 ATU->unlinkTemporaryFile();
Steve Naroffe19944c2009-10-15 22:23:48 +0000583 return ATU;
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000584}
585
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000586void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000587 assert(CTUnit && "Passed null CXTranslationUnit");
588 delete static_cast<ASTUnit *>(CTUnit);
589}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000590
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000591CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000592 assert(CTUnit && "Passed null CXTranslationUnit");
Steve Naroff77accc12009-09-03 18:19:54 +0000593 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000594 return createCXString(CXXUnit->getOriginalSourceFileName().c_str(), true);
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000595}
Daniel Dunbar1eb79b52009-08-28 16:30:07 +0000596
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000597void clang_loadTranslationUnit(CXTranslationUnit CTUnit,
Steve Naroffc857ea42009-09-02 13:28:54 +0000598 CXTranslationUnitIterator callback,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000599 CXClientData CData) {
Steve Naroff50398192009-08-28 15:28:48 +0000600 assert(CTUnit && "Passed null CXTranslationUnit");
601 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
602 ASTContext &Ctx = CXXUnit->getASTContext();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000603
Daniel Dunbar8506dde2009-12-03 01:54:28 +0000604 unsigned PCHLevel = Decl::MaxPCHLevel;
605
606 // Set the PCHLevel to filter out unwanted decls if requested.
607 if (CXXUnit->getOnlyLocalDecls()) {
608 PCHLevel = 0;
609
610 // If the main input was an AST, bump the level.
611 if (CXXUnit->isMainFileAST())
612 ++PCHLevel;
613 }
614
615 TUVisitor DVisit(CTUnit, callback, CData, PCHLevel);
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000616
617 // If using a non-AST based ASTUnit, iterate over the stored list of top-level
618 // decls.
619 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls()) {
620 const std::vector<Decl*> &TLDs = CXXUnit->getTopLevelDecls();
621 for (std::vector<Decl*>::const_iterator it = TLDs.begin(),
622 ie = TLDs.end(); it != ie; ++it) {
623 DVisit.Visit(*it);
624 }
625 } else
626 DVisit.Visit(Ctx.getTranslationUnitDecl());
Steve Naroff600866c2009-08-27 19:51:58 +0000627}
628
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000629void clang_loadDeclaration(CXDecl Dcl,
630 CXDeclIterator callback,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000631 CXClientData CData) {
Steve Naroffc857ea42009-09-02 13:28:54 +0000632 assert(Dcl && "Passed null CXDecl");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000633
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000634 CDeclVisitor DVisit(Dcl, callback, CData,
635 static_cast<Decl *>(Dcl)->getPCHLevel());
Steve Naroffc857ea42009-09-02 13:28:54 +0000636 DVisit.Visit(static_cast<Decl *>(Dcl));
Steve Naroff600866c2009-08-27 19:51:58 +0000637}
638
Steve Naroff7e8f8182009-08-28 12:07:44 +0000639// Some notes on CXEntity:
640//
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000641// - Since the 'ordinary' namespace includes functions, data, typedefs,
642// ObjC interfaces, thecurrent algorithm is a bit naive (resulting in one
Steve Naroff7e8f8182009-08-28 12:07:44 +0000643// entity for 2 different types). For example:
644//
645// module1.m: @interface Foo @end Foo *x;
646// module2.m: void Foo(int);
647//
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000648// - Since the unique name spans translation units, static data/functions
Steve Naroff7e8f8182009-08-28 12:07:44 +0000649// within a CXTranslationUnit are *not* currently represented by entities.
650// As a result, there will be no entity for the following:
651//
652// module.m: static void Foo() { }
653//
654
655
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000656const char *clang_getDeclarationName(CXEntity) {
Steve Naroff600866c2009-08-27 19:51:58 +0000657 return "";
658}
659
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000660const char *clang_getURI(CXEntity) {
661 return "";
662}
663
664CXEntity clang_getEntity(const char *URI) {
Steve Naroff600866c2009-08-27 19:51:58 +0000665 return 0;
666}
667
668//
669// CXDecl Operations.
670//
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000671
672CXEntity clang_getEntityFromDecl(CXDecl) {
Steve Naroff600866c2009-08-27 19:51:58 +0000673 return 0;
674}
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000675
676CXString clang_getDeclSpelling(CXDecl AnonDecl) {
Steve Naroff89922f82009-08-31 00:59:03 +0000677 assert(AnonDecl && "Passed null CXDecl");
678 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
Steve Naroffef0cef62009-11-09 17:45:52 +0000679
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000680 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
681 return createCXString(OMD->getSelector().getAsString().c_str(), true);
682
683 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
Steve Naroff0d69b8c2009-10-29 21:11:04 +0000684 // No, this isn't the same as the code below. getIdentifier() is non-virtual
685 // and returns different names. NamedDecl returns the class name and
686 // ObjCCategoryImplDecl returns the category name.
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000687 return createCXString(CIMP->getIdentifier()->getNameStart());
688
689 if (ND->getIdentifier())
690 return createCXString(ND->getIdentifier()->getNameStart());
691
692 return createCXString("");
Steve Naroff600866c2009-08-27 19:51:58 +0000693}
Steve Narofff334b4e2009-09-02 18:26:48 +0000694
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000695unsigned clang_getDeclLine(CXDecl AnonDecl) {
Steve Naroff699a07d2009-09-25 21:32:34 +0000696 assert(AnonDecl && "Passed null CXDecl");
697 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
698 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
699 return SourceMgr.getSpellingLineNumber(ND->getLocation());
700}
701
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000702unsigned clang_getDeclColumn(CXDecl AnonDecl) {
Steve Naroff699a07d2009-09-25 21:32:34 +0000703 assert(AnonDecl && "Passed null CXDecl");
704 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
705 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Steve Naroff74165242009-09-25 22:15:54 +0000706 return SourceMgr.getSpellingColumnNumber(ND->getLocation());
Steve Naroff699a07d2009-09-25 21:32:34 +0000707}
708
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000709const char *clang_getDeclSource(CXDecl AnonDecl) {
Steve Naroffee9405e2009-09-25 21:45:39 +0000710 assert(AnonDecl && "Passed null CXDecl");
Steve Naroff88145032009-10-27 14:35:18 +0000711 FileEntry *FEnt = static_cast<FileEntry *>(clang_getDeclSourceFile(AnonDecl));
712 assert (FEnt && "Cannot find FileEntry for Decl");
713 return clang_getFileName(FEnt);
714}
715
716static const FileEntry *getFileEntryFromSourceLocation(SourceManager &SMgr,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000717 SourceLocation SLoc) {
Steve Naroff88145032009-10-27 14:35:18 +0000718 FileID FID;
719 if (SLoc.isFileID())
720 FID = SMgr.getFileID(SLoc);
721 else
722 FID = SMgr.getDecomposedSpellingLoc(SLoc).first;
723 return SMgr.getFileEntryForID(FID);
724}
725
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000726CXFile clang_getDeclSourceFile(CXDecl AnonDecl) {
Steve Naroff88145032009-10-27 14:35:18 +0000727 assert(AnonDecl && "Passed null CXDecl");
Steve Naroffee9405e2009-09-25 21:45:39 +0000728 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
729 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Steve Naroff88145032009-10-27 14:35:18 +0000730 return (void *)getFileEntryFromSourceLocation(SourceMgr, ND->getLocation());
731}
732
733const char *clang_getFileName(CXFile SFile) {
734 assert(SFile && "Passed null CXFile");
735 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
736 return FEnt->getName();
737}
738
739time_t clang_getFileTime(CXFile SFile) {
740 assert(SFile && "Passed null CXFile");
741 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
742 return FEnt->getModificationTime();
Steve Naroffee9405e2009-09-25 21:45:39 +0000743}
744
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000745CXString clang_getCursorSpelling(CXCursor C) {
Steve Narofff334b4e2009-09-02 18:26:48 +0000746 assert(C.decl && "CXCursor has null decl");
747 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
Steve Naroffef0cef62009-11-09 17:45:52 +0000748
Steve Narofff334b4e2009-09-02 18:26:48 +0000749 if (clang_isReference(C.kind)) {
750 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000751 case CXCursor_ObjCSuperClassRef: {
752 ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(ND);
753 assert(OID && "clang_getCursorLine(): Missing interface decl");
754 return createCXString(OID->getSuperClass()->getIdentifier()
755 ->getNameStart());
756 }
757 case CXCursor_ObjCClassRef: {
758 if (ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(ND))
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000759 return createCXString(OID->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +0000760
761 ObjCCategoryDecl *OCD = dyn_cast<ObjCCategoryDecl>(ND);
762 assert(OCD && "clang_getCursorLine(): Missing category decl");
763 return createCXString(OCD->getClassInterface()->getIdentifier()
764 ->getNameStart());
765 }
766 case CXCursor_ObjCProtocolRef: {
767 ObjCProtocolDecl *OID = dyn_cast<ObjCProtocolDecl>(ND);
768 assert(OID && "clang_getCursorLine(): Missing protocol decl");
769 return createCXString(OID->getIdentifier()->getNameStart());
770 }
771 case CXCursor_ObjCSelectorRef: {
772 ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(
773 static_cast<Stmt *>(C.stmt));
774 assert(OME && "clang_getCursorLine(): Missing message expr");
775 return createCXString(OME->getSelector().getAsString().c_str(), true);
776 }
777 case CXCursor_VarRef:
778 case CXCursor_FunctionRef:
779 case CXCursor_EnumConstantRef: {
780 DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(
781 static_cast<Stmt *>(C.stmt));
782 assert(DRE && "clang_getCursorLine(): Missing decl ref expr");
783 return createCXString(DRE->getDecl()->getIdentifier()->getNameStart());
784 }
785 default:
786 return createCXString("<not implemented>");
Steve Narofff334b4e2009-09-02 18:26:48 +0000787 }
788 }
789 return clang_getDeclSpelling(C.decl);
790}
791
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000792const char *clang_getCursorKindSpelling(enum CXCursorKind Kind) {
Steve Naroff89922f82009-08-31 00:59:03 +0000793 switch (Kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000794 case CXCursor_FunctionDecl: return "FunctionDecl";
795 case CXCursor_TypedefDecl: return "TypedefDecl";
796 case CXCursor_EnumDecl: return "EnumDecl";
797 case CXCursor_EnumConstantDecl: return "EnumConstantDecl";
798 case CXCursor_StructDecl: return "StructDecl";
799 case CXCursor_UnionDecl: return "UnionDecl";
800 case CXCursor_ClassDecl: return "ClassDecl";
801 case CXCursor_FieldDecl: return "FieldDecl";
802 case CXCursor_VarDecl: return "VarDecl";
803 case CXCursor_ParmDecl: return "ParmDecl";
804 case CXCursor_ObjCInterfaceDecl: return "ObjCInterfaceDecl";
805 case CXCursor_ObjCCategoryDecl: return "ObjCCategoryDecl";
806 case CXCursor_ObjCProtocolDecl: return "ObjCProtocolDecl";
807 case CXCursor_ObjCPropertyDecl: return "ObjCPropertyDecl";
808 case CXCursor_ObjCIvarDecl: return "ObjCIvarDecl";
809 case CXCursor_ObjCInstanceMethodDecl: return "ObjCInstanceMethodDecl";
810 case CXCursor_ObjCClassMethodDecl: return "ObjCClassMethodDecl";
811 case CXCursor_FunctionDefn: return "FunctionDefn";
812 case CXCursor_ObjCInstanceMethodDefn: return "ObjCInstanceMethodDefn";
813 case CXCursor_ObjCClassMethodDefn: return "ObjCClassMethodDefn";
814 case CXCursor_ObjCClassDefn: return "ObjCClassDefn";
815 case CXCursor_ObjCCategoryDefn: return "ObjCCategoryDefn";
816 case CXCursor_ObjCSuperClassRef: return "ObjCSuperClassRef";
817 case CXCursor_ObjCProtocolRef: return "ObjCProtocolRef";
818 case CXCursor_ObjCClassRef: return "ObjCClassRef";
819 case CXCursor_ObjCSelectorRef: return "ObjCSelectorRef";
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000820
Daniel Dunbaracca7252009-11-30 20:42:49 +0000821 case CXCursor_VarRef: return "VarRef";
822 case CXCursor_FunctionRef: return "FunctionRef";
823 case CXCursor_EnumConstantRef: return "EnumConstantRef";
824 case CXCursor_MemberRef: return "MemberRef";
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000825
Daniel Dunbaracca7252009-11-30 20:42:49 +0000826 case CXCursor_InvalidFile: return "InvalidFile";
827 case CXCursor_NoDeclFound: return "NoDeclFound";
828 case CXCursor_NotImplemented: return "NotImplemented";
829 default: return "<not implemented>";
Steve Naroff89922f82009-08-31 00:59:03 +0000830 }
Steve Naroff600866c2009-08-27 19:51:58 +0000831}
Steve Naroff89922f82009-08-31 00:59:03 +0000832
Steve Naroff9efa7672009-09-04 15:44:05 +0000833static enum CXCursorKind TranslateKind(Decl *D) {
834 switch (D->getKind()) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000835 case Decl::Function: return CXCursor_FunctionDecl;
836 case Decl::Typedef: return CXCursor_TypedefDecl;
837 case Decl::Enum: return CXCursor_EnumDecl;
838 case Decl::EnumConstant: return CXCursor_EnumConstantDecl;
839 case Decl::Record: return CXCursor_StructDecl; // FIXME: union/class
840 case Decl::Field: return CXCursor_FieldDecl;
841 case Decl::Var: return CXCursor_VarDecl;
842 case Decl::ParmVar: return CXCursor_ParmDecl;
843 case Decl::ObjCInterface: return CXCursor_ObjCInterfaceDecl;
844 case Decl::ObjCCategory: return CXCursor_ObjCCategoryDecl;
845 case Decl::ObjCProtocol: return CXCursor_ObjCProtocolDecl;
846 case Decl::ObjCMethod: {
847 ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D);
848 if (MD->isInstanceMethod())
849 return CXCursor_ObjCInstanceMethodDecl;
850 return CXCursor_ObjCClassMethodDecl;
851 }
852 default: break;
Steve Naroff9efa7672009-09-04 15:44:05 +0000853 }
Steve Naroff77128dd2009-09-15 20:25:34 +0000854 return CXCursor_NotImplemented;
Steve Naroff9efa7672009-09-04 15:44:05 +0000855}
Steve Naroff600866c2009-08-27 19:51:58 +0000856//
857// CXCursor Operations.
858//
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000859
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000860CXCursor clang_getCursor(CXTranslationUnit CTUnit, const char *source_name,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000861 unsigned line, unsigned column) {
Steve Naroff9efa7672009-09-04 15:44:05 +0000862 assert(CTUnit && "Passed null CXTranslationUnit");
863 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000864
Steve Naroff9efa7672009-09-04 15:44:05 +0000865 FileManager &FMgr = CXXUnit->getFileManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000866 const FileEntry *File = FMgr.getFile(source_name,
867 source_name+strlen(source_name));
Steve Naroff77128dd2009-09-15 20:25:34 +0000868 if (!File) {
Steve Narofffb570422009-09-22 19:25:29 +0000869 CXCursor C = { CXCursor_InvalidFile, 0, 0 };
Steve Naroff77128dd2009-09-15 20:25:34 +0000870 return C;
871 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000872 SourceLocation SLoc =
Steve Naroff9efa7672009-09-04 15:44:05 +0000873 CXXUnit->getSourceManager().getLocation(File, line, column);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000874
Steve Narofff96b5242009-10-28 20:44:47 +0000875 ASTLocation LastLoc = CXXUnit->getLastASTLocation();
876
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000877 ASTLocation ALoc = ResolveLocationInAST(CXXUnit->getASTContext(), SLoc,
Steve Narofff96b5242009-10-28 20:44:47 +0000878 &LastLoc);
879 if (ALoc.isValid())
880 CXXUnit->setLastASTLocation(ALoc);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000881
Argyrios Kyrtzidisf4526e32009-09-29 19:44:27 +0000882 Decl *Dcl = ALoc.getParentDecl();
Argyrios Kyrtzidis05a76512009-09-29 19:45:58 +0000883 if (ALoc.isNamedRef())
884 Dcl = ALoc.AsNamedRef().ND;
Argyrios Kyrtzidisf4526e32009-09-29 19:44:27 +0000885 Stmt *Stm = ALoc.dyn_AsStmt();
Steve Naroff4ade6d62009-09-23 17:52:52 +0000886 if (Dcl) {
887 if (Stm) {
888 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Stm)) {
889 CXCursor C = { TranslateDeclRefExpr(DRE), Dcl, Stm };
890 return C;
891 } else if (ObjCMessageExpr *MExp = dyn_cast<ObjCMessageExpr>(Stm)) {
892 CXCursor C = { CXCursor_ObjCSelectorRef, Dcl, MExp };
893 return C;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000894 }
Steve Naroff4ade6d62009-09-23 17:52:52 +0000895 // Fall through...treat as a decl, not a ref.
896 }
Steve Naroff85e2db72009-10-01 00:31:07 +0000897 if (ALoc.isNamedRef()) {
898 if (isa<ObjCInterfaceDecl>(Dcl)) {
899 CXCursor C = { CXCursor_ObjCClassRef, Dcl, ALoc.getParentDecl() };
900 return C;
901 }
902 if (isa<ObjCProtocolDecl>(Dcl)) {
903 CXCursor C = { CXCursor_ObjCProtocolRef, Dcl, ALoc.getParentDecl() };
904 return C;
905 }
906 }
Daniel Dunbaracca7252009-11-30 20:42:49 +0000907 CXCursor C = { TranslateKind(Dcl), Dcl, 0 };
Steve Naroff77128dd2009-09-15 20:25:34 +0000908 return C;
909 }
Steve Narofffb570422009-09-22 19:25:29 +0000910 CXCursor C = { CXCursor_NoDeclFound, 0, 0 };
Steve Naroff9efa7672009-09-04 15:44:05 +0000911 return C;
Steve Naroff600866c2009-08-27 19:51:58 +0000912}
913
Ted Kremenek73885552009-11-17 19:28:59 +0000914CXCursor clang_getNullCursor(void) {
915 CXCursor C;
916 C.kind = CXCursor_InvalidFile;
917 C.decl = NULL;
918 C.stmt = NULL;
919 return C;
920}
921
922unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
923 return X.kind == Y.kind && X.decl == Y.decl && X.stmt == Y.stmt;
924}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000925
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000926CXCursor clang_getCursorFromDecl(CXDecl AnonDecl) {
Steve Naroff77128dd2009-09-15 20:25:34 +0000927 assert(AnonDecl && "Passed null CXDecl");
928 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000929
Steve Narofffb570422009-09-22 19:25:29 +0000930 CXCursor C = { TranslateKind(ND), ND, 0 };
Steve Naroff77128dd2009-09-15 20:25:34 +0000931 return C;
932}
933
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000934unsigned clang_isInvalid(enum CXCursorKind K) {
Steve Naroff77128dd2009-09-15 20:25:34 +0000935 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
936}
937
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000938unsigned clang_isDeclaration(enum CXCursorKind K) {
Steve Naroff89922f82009-08-31 00:59:03 +0000939 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
940}
Steve Naroff2d4d6292009-08-31 14:26:51 +0000941
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000942unsigned clang_isReference(enum CXCursorKind K) {
Steve Narofff334b4e2009-09-02 18:26:48 +0000943 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
944}
945
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000946unsigned clang_isDefinition(enum CXCursorKind K) {
Steve Narofff334b4e2009-09-02 18:26:48 +0000947 return K >= CXCursor_FirstDefn && K <= CXCursor_LastDefn;
948}
949
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000950CXCursorKind clang_getCursorKind(CXCursor C) {
Steve Naroff9efa7672009-09-04 15:44:05 +0000951 return C.kind;
952}
953
Steve Naroff699a07d2009-09-25 21:32:34 +0000954static Decl *getDeclFromExpr(Stmt *E) {
955 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
956 return RefExpr->getDecl();
957 if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
958 return ME->getMemberDecl();
959 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
960 return RE->getDecl();
961
962 if (CallExpr *CE = dyn_cast<CallExpr>(E))
963 return getDeclFromExpr(CE->getCallee());
964 if (CastExpr *CE = dyn_cast<CastExpr>(E))
965 return getDeclFromExpr(CE->getSubExpr());
966 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
967 return OME->getMethodDecl();
968
969 return 0;
970}
971
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000972CXDecl clang_getCursorDecl(CXCursor C) {
Steve Naroff699a07d2009-09-25 21:32:34 +0000973 if (clang_isDeclaration(C.kind))
974 return C.decl;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000975
Steve Naroff699a07d2009-09-25 21:32:34 +0000976 if (clang_isReference(C.kind)) {
Steve Naroff85e2db72009-10-01 00:31:07 +0000977 if (C.stmt) {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000978 if (C.kind == CXCursor_ObjCClassRef ||
Steve Narofff9adf8f2009-10-05 17:58:19 +0000979 C.kind == CXCursor_ObjCProtocolRef)
Steve Naroff85e2db72009-10-01 00:31:07 +0000980 return static_cast<Stmt *>(C.stmt);
981 else
982 return getDeclFromExpr(static_cast<Stmt *>(C.stmt));
983 } else
Steve Naroff699a07d2009-09-25 21:32:34 +0000984 return C.decl;
985 }
986 return 0;
Steve Naroff9efa7672009-09-04 15:44:05 +0000987}
988
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000989unsigned clang_getCursorLine(CXCursor C) {
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);
Steve Naroff2d4d6292009-08-31 14:26:51 +0000995 return SourceMgr.getSpellingLineNumber(SLoc);
Steve Naroff600866c2009-08-27 19:51:58 +0000996}
Steve Narofff334b4e2009-09-02 18:26:48 +0000997
Steve Naroffef0cef62009-11-09 17:45:52 +0000998const char *clang_getCString(CXString string) {
999 return string.Spelling;
1000}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001001
Steve Naroffef0cef62009-11-09 17:45:52 +00001002void clang_disposeString(CXString string) {
Benjamin Kramer858e5de2009-11-09 18:24:53 +00001003 if (string.MustFreeString)
1004 free((void*)string.Spelling);
Steve Naroffef0cef62009-11-09 17:45:52 +00001005}
1006
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001007unsigned clang_getCursorColumn(CXCursor C) {
Steve Naroff2d4d6292009-08-31 14:26:51 +00001008 assert(C.decl && "CXCursor has null decl");
1009 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
Steve Naroff2d4d6292009-08-31 14:26:51 +00001010 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001011
Steve Narofff334b4e2009-09-02 18:26:48 +00001012 SourceLocation SLoc = getLocationFromCursor(C, SourceMgr, ND);
Steve Naroff2d4d6292009-08-31 14:26:51 +00001013 return SourceMgr.getSpellingColumnNumber(SLoc);
Steve Naroff600866c2009-08-27 19:51:58 +00001014}
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001015
1016const char *clang_getCursorSource(CXCursor C) {
Steve Naroff2d4d6292009-08-31 14:26:51 +00001017 assert(C.decl && "CXCursor has null decl");
1018 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
Steve Naroff2d4d6292009-08-31 14:26:51 +00001019 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001020
Steve Narofff334b4e2009-09-02 18:26:48 +00001021 SourceLocation SLoc = getLocationFromCursor(C, SourceMgr, ND);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001022
Ted Kremenek9298cfc2009-11-17 05:31:58 +00001023 if (SLoc.isFileID()) {
1024 const char *bufferName = SourceMgr.getBufferName(SLoc);
1025 return bufferName[0] == '<' ? NULL : bufferName;
1026 }
Douglas Gregor02465752009-10-16 21:24:31 +00001027
1028 // Retrieve the file in which the macro was instantiated, then provide that
1029 // buffer name.
1030 // FIXME: Do we want to give specific macro-instantiation information?
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001031 const llvm::MemoryBuffer *Buffer
Douglas Gregor02465752009-10-16 21:24:31 +00001032 = SourceMgr.getBuffer(SourceMgr.getDecomposedSpellingLoc(SLoc).first);
1033 if (!Buffer)
1034 return 0;
1035
1036 return Buffer->getBufferIdentifier();
Steve Naroff600866c2009-08-27 19:51:58 +00001037}
1038
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001039CXFile clang_getCursorSourceFile(CXCursor C) {
Steve Naroff88145032009-10-27 14:35:18 +00001040 assert(C.decl && "CXCursor has null decl");
1041 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
1042 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001043
Steve Naroff88145032009-10-27 14:35:18 +00001044 return (void *)getFileEntryFromSourceLocation(SourceMgr,
Daniel Dunbaracca7252009-11-30 20:42:49 +00001045 getLocationFromCursor(C,SourceMgr, ND));
Steve Naroff88145032009-10-27 14:35:18 +00001046}
1047
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001048void clang_getDefinitionSpellingAndExtent(CXCursor C,
Steve Naroff4ade6d62009-09-23 17:52:52 +00001049 const char **startBuf,
1050 const char **endBuf,
1051 unsigned *startLine,
1052 unsigned *startColumn,
1053 unsigned *endLine,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001054 unsigned *endColumn) {
Steve Naroff4ade6d62009-09-23 17:52:52 +00001055 assert(C.decl && "CXCursor has null decl");
1056 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
1057 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
1058 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001059
Steve Naroff4ade6d62009-09-23 17:52:52 +00001060 SourceManager &SM = FD->getASTContext().getSourceManager();
1061 *startBuf = SM.getCharacterData(Body->getLBracLoc());
1062 *endBuf = SM.getCharacterData(Body->getRBracLoc());
1063 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
1064 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
1065 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
1066 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
1067}
1068
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001069enum CXCompletionChunkKind
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001070clang_getCompletionChunkKind(CXCompletionString completion_string,
1071 unsigned chunk_number) {
1072 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1073 if (!CCStr || chunk_number >= CCStr->size())
1074 return CXCompletionChunk_Text;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001075
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001076 switch ((*CCStr)[chunk_number].Kind) {
1077 case CodeCompletionString::CK_TypedText:
1078 return CXCompletionChunk_TypedText;
1079 case CodeCompletionString::CK_Text:
1080 return CXCompletionChunk_Text;
1081 case CodeCompletionString::CK_Optional:
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001082 return CXCompletionChunk_Optional;
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001083 case CodeCompletionString::CK_Placeholder:
1084 return CXCompletionChunk_Placeholder;
1085 case CodeCompletionString::CK_Informative:
1086 return CXCompletionChunk_Informative;
1087 case CodeCompletionString::CK_CurrentParameter:
1088 return CXCompletionChunk_CurrentParameter;
1089 case CodeCompletionString::CK_LeftParen:
1090 return CXCompletionChunk_LeftParen;
1091 case CodeCompletionString::CK_RightParen:
1092 return CXCompletionChunk_RightParen;
1093 case CodeCompletionString::CK_LeftBracket:
1094 return CXCompletionChunk_LeftBracket;
1095 case CodeCompletionString::CK_RightBracket:
1096 return CXCompletionChunk_RightBracket;
1097 case CodeCompletionString::CK_LeftBrace:
1098 return CXCompletionChunk_LeftBrace;
1099 case CodeCompletionString::CK_RightBrace:
1100 return CXCompletionChunk_RightBrace;
1101 case CodeCompletionString::CK_LeftAngle:
1102 return CXCompletionChunk_LeftAngle;
1103 case CodeCompletionString::CK_RightAngle:
1104 return CXCompletionChunk_RightAngle;
1105 case CodeCompletionString::CK_Comma:
1106 return CXCompletionChunk_Comma;
1107 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001108
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001109 // Should be unreachable, but let's be careful.
1110 return CXCompletionChunk_Text;
1111}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001112
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001113const char *clang_getCompletionChunkText(CXCompletionString completion_string,
1114 unsigned chunk_number) {
1115 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1116 if (!CCStr || chunk_number >= CCStr->size())
1117 return 0;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001118
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001119 switch ((*CCStr)[chunk_number].Kind) {
1120 case CodeCompletionString::CK_TypedText:
1121 case CodeCompletionString::CK_Text:
1122 case CodeCompletionString::CK_Placeholder:
1123 case CodeCompletionString::CK_CurrentParameter:
1124 case CodeCompletionString::CK_Informative:
1125 case CodeCompletionString::CK_LeftParen:
1126 case CodeCompletionString::CK_RightParen:
1127 case CodeCompletionString::CK_LeftBracket:
1128 case CodeCompletionString::CK_RightBracket:
1129 case CodeCompletionString::CK_LeftBrace:
1130 case CodeCompletionString::CK_RightBrace:
1131 case CodeCompletionString::CK_LeftAngle:
1132 case CodeCompletionString::CK_RightAngle:
1133 case CodeCompletionString::CK_Comma:
1134 return (*CCStr)[chunk_number].Text;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001135
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001136 case CodeCompletionString::CK_Optional:
1137 // Note: treated as an empty text block.
1138 return 0;
1139 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001140
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001141 // Should be unreachable, but let's be careful.
1142 return 0;
1143}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001144
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001145CXCompletionString
1146clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
1147 unsigned chunk_number) {
1148 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1149 if (!CCStr || chunk_number >= CCStr->size())
1150 return 0;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001151
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001152 switch ((*CCStr)[chunk_number].Kind) {
1153 case CodeCompletionString::CK_TypedText:
1154 case CodeCompletionString::CK_Text:
1155 case CodeCompletionString::CK_Placeholder:
1156 case CodeCompletionString::CK_CurrentParameter:
1157 case CodeCompletionString::CK_Informative:
1158 case CodeCompletionString::CK_LeftParen:
1159 case CodeCompletionString::CK_RightParen:
1160 case CodeCompletionString::CK_LeftBracket:
1161 case CodeCompletionString::CK_RightBracket:
1162 case CodeCompletionString::CK_LeftBrace:
1163 case CodeCompletionString::CK_RightBrace:
1164 case CodeCompletionString::CK_LeftAngle:
1165 case CodeCompletionString::CK_RightAngle:
1166 case CodeCompletionString::CK_Comma:
1167 return 0;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001168
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001169 case CodeCompletionString::CK_Optional:
1170 // Note: treated as an empty text block.
1171 return (*CCStr)[chunk_number].Optional;
1172 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001173
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001174 // Should be unreachable, but let's be careful.
1175 return 0;
1176}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001177
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001178unsigned clang_getNumCompletionChunks(CXCompletionString completion_string) {
1179 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1180 return CCStr? CCStr->size() : 0;
1181}
Steve Naroff4ade6d62009-09-23 17:52:52 +00001182
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001183static bool ReadUnsigned(const char *&Memory, const char *MemoryEnd,
1184 unsigned &Value) {
1185 if (Memory + sizeof(unsigned) > MemoryEnd)
1186 return true;
1187
1188 memmove(&Value, Memory, sizeof(unsigned));
1189 Memory += sizeof(unsigned);
1190 return false;
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001191}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001192
1193void clang_codeComplete(CXIndex CIdx,
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001194 const char *source_filename,
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001195 int num_command_line_args,
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001196 const char **command_line_args,
Douglas Gregor735df882009-12-02 09:21:34 +00001197 unsigned num_unsaved_files,
1198 struct CXUnsavedFile *unsaved_files,
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001199 const char *complete_filename,
1200 unsigned complete_line,
1201 unsigned complete_column,
1202 CXCompletionIterator completion_iterator,
1203 CXClientData client_data) {
1204 // The indexer, which is mainly used to determine where diagnostics go.
1205 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001206
Douglas Gregor735df882009-12-02 09:21:34 +00001207 // The set of temporary files that we've built.
1208 std::vector<llvm::sys::Path> TemporaryFiles;
1209
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001210 // Build up the arguments for invoking 'clang'.
1211 std::vector<const char *> argv;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001212
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001213 // First add the complete path to the 'clang' executable.
1214 llvm::sys::Path ClangPath = CXXIdx->getClangPath();
1215 argv.push_back(ClangPath.c_str());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001216
1217 // Add the '-fsyntax-only' argument so that we only perform a basic
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001218 // syntax check of the code.
1219 argv.push_back("-fsyntax-only");
1220
1221 // Add the appropriate '-code-completion-at=file:line:column' argument
1222 // to perform code completion, with an "-Xclang" preceding it.
1223 std::string code_complete_at;
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001224 code_complete_at += complete_filename;
1225 code_complete_at += ":";
1226 code_complete_at += llvm::utostr(complete_line);
1227 code_complete_at += ":";
1228 code_complete_at += llvm::utostr(complete_column);
1229 argv.push_back("-Xclang");
Daniel Dunbar7bd71652009-12-03 05:32:40 +00001230 argv.push_back("-code-completion-at");
1231 argv.push_back("-Xclang");
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001232 argv.push_back(code_complete_at.c_str());
1233 argv.push_back("-Xclang");
Daniel Dunbar4db166b2009-11-19 05:32:09 +00001234 argv.push_back("-no-code-completion-debug-printer");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001235
Douglas Gregor735df882009-12-02 09:21:34 +00001236 std::vector<std::string> RemapArgs;
1237 for (unsigned i = 0; i != num_unsaved_files; ++i) {
1238 char tmpFile[L_tmpnam];
1239 char *tmpFileName = tmpnam(tmpFile);
1240
1241 // Write the contents of this unsaved file into the temporary file.
1242 llvm::sys::Path SavedFile(tmpFileName);
1243 std::string ErrorInfo;
1244 llvm::raw_fd_ostream OS(SavedFile.c_str(), ErrorInfo);
1245 if (!ErrorInfo.empty())
1246 continue;
1247
1248 OS.write(unsaved_files[i].Contents, unsaved_files[i].Length);
1249 OS.close();
1250 if (OS.has_error()) {
1251 SavedFile.eraseFromDisk();
1252 continue;
1253 }
1254
1255 // Remap the file.
Daniel Dunbar7bd71652009-12-03 05:32:40 +00001256 std::string RemapArg = unsaved_files[i].Filename;
Douglas Gregor735df882009-12-02 09:21:34 +00001257 RemapArg += ';';
1258 RemapArg += tmpFileName;
1259 RemapArgs.push_back("-Xclang");
Daniel Dunbar7bd71652009-12-03 05:32:40 +00001260 RemapArgs.push_back("-remap-file");
1261 RemapArgs.push_back("-Xclang");
Douglas Gregor735df882009-12-02 09:21:34 +00001262 RemapArgs.push_back(RemapArg);
1263 TemporaryFiles.push_back(SavedFile);
1264 }
1265
1266 // The pointers into the elements of RemapArgs are stable because we
1267 // won't be adding anything to RemapArgs after this point.
1268 for (unsigned i = 0, e = RemapArgs.size(); i != e; ++i)
1269 argv.push_back(RemapArgs[i].c_str());
1270
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001271 // Add the source file name (FIXME: later, we'll want to build temporary
1272 // file from the buffer, or just feed the source text via standard input).
Ted Kremenek4633d1b2009-11-17 18:18:02 +00001273 if (source_filename)
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001274 argv.push_back(source_filename);
1275
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001276 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
1277 for (int i = 0; i < num_command_line_args; ++i)
1278 if (const char *arg = command_line_args[i]) {
1279 if (strcmp(arg, "-o") == 0) {
1280 ++i; // Also skip the matching argument.
1281 continue;
1282 }
1283 if (strcmp(arg, "-emit-ast") == 0 ||
1284 strcmp(arg, "-c") == 0 ||
1285 strcmp(arg, "-fsyntax-only") == 0) {
1286 continue;
1287 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001288
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001289 // Keep the argument.
1290 argv.push_back(arg);
1291 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001292
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001293 // Add the null terminator.
1294 argv.push_back(NULL);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001295
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001296 // Generate a temporary name for the AST file.
1297 char tmpFile[L_tmpnam];
1298 char *tmpFileName = tmpnam(tmpFile);
1299 llvm::sys::Path ResultsFile(tmpFileName);
Douglas Gregor735df882009-12-02 09:21:34 +00001300 TemporaryFiles.push_back(ResultsFile);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001301
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001302 // Invoke 'clang'.
1303 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
1304 // on Unix or NUL (Windows).
1305 std::string ErrMsg;
1306 const llvm::sys::Path *Redirects[] = { &DevNull, &ResultsFile, &DevNull, 0 };
1307 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
1308 /* redirects */ &Redirects[0],
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001309 /* secondsToWait */ 0,
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001310 /* memoryLimits */ 0, &ErrMsg);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001311
Ted Kremenek0854d702009-11-10 19:18:52 +00001312 if (CXXIdx->getDisplayDiagnostics() && !ErrMsg.empty()) {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001313 llvm::errs() << "clang_codeComplete: " << ErrMsg
Daniel Dunbaracca7252009-11-30 20:42:49 +00001314 << '\n' << "Arguments: \n";
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001315 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
1316 I!=E; ++I) {
1317 if (*I)
1318 llvm::errs() << ' ' << *I << '\n';
1319 }
1320 llvm::errs() << '\n';
1321 }
1322
1323 // Parse the resulting source file to find code-completion results.
1324 using llvm::MemoryBuffer;
1325 using llvm::StringRef;
1326 if (MemoryBuffer *F = MemoryBuffer::getFile(ResultsFile.c_str())) {
1327 StringRef Buffer = F->getBuffer();
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001328 for (const char *Str = Buffer.data(), *StrEnd = Str + Buffer.size();
1329 Str < StrEnd;) {
1330 unsigned KindValue;
1331 if (ReadUnsigned(Str, StrEnd, KindValue))
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001332 break;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001333
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001334 CodeCompletionString *CCStr
1335 = CodeCompletionString::Deserialize(Str, StrEnd);
1336 if (!CCStr)
1337 continue;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001338
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001339 if (!CCStr->empty()) {
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001340 // Vend the code-completion result to the caller.
1341 CXCompletionResult Result;
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001342 Result.CursorKind = (CXCursorKind)KindValue;
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001343 Result.CompletionString = CCStr;
1344 if (completion_iterator)
1345 completion_iterator(&Result, client_data);
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001346 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001347
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001348 delete CCStr;
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001349 };
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001350 delete F;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001351 }
1352
Douglas Gregor735df882009-12-02 09:21:34 +00001353 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i)
1354 TemporaryFiles[i].eraseFromDisk();
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001355}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001356
Steve Naroff600866c2009-08-27 19:51:58 +00001357} // end extern "C"