blob: a5b7e996229a763ae9156dc1d6f9109ad77ef490 [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
327 Diagnostic &getDiags() {
328 return DisplayDiagnostics ? *TextDiags : IgnoreDiags;
329 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000330
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000331 /// \brief Get the path of the clang binary.
Benjamin Kramerc5a9e952009-10-19 10:20:24 +0000332 const llvm::sys::Path& getClangPath();
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000333};
Steve Naroff89922f82009-08-31 00:59:03 +0000334
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000335const llvm::sys::Path& CIndexer::getClangPath() {
336 // Did we already compute the path?
337 if (!ClangPath.empty())
338 return ClangPath;
339
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000340 // Find the location where this library lives (libCIndex.dylib).
Benjamin Kramer20d75812009-10-18 16:13:48 +0000341#ifdef LLVM_ON_WIN32
342 MEMORY_BASIC_INFORMATION mbi;
343 char path[MAX_PATH];
Benjamin Krameredcd8282009-10-18 16:20:58 +0000344 VirtualQuery((void *)(uintptr_t)clang_createTranslationUnit, &mbi,
Benjamin Kramer20d75812009-10-18 16:13:48 +0000345 sizeof(mbi));
346 GetModuleFileNameA((HINSTANCE)mbi.AllocationBase, path, MAX_PATH);
347
348 llvm::sys::Path CIndexPath(path);
John Thompson6a6742a2009-11-11 23:11:14 +0000349
350 CIndexPath.eraseComponent();
351 CIndexPath.appendComponent("clang");
352 CIndexPath.appendSuffix("exe");
353 CIndexPath.makeAbsolute();
Benjamin Kramer20d75812009-10-18 16:13:48 +0000354#else
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000355 // This silly cast below avoids a C++ warning.
356 Dl_info info;
357 if (dladdr((void *)(uintptr_t)clang_createTranslationUnit, &info) == 0)
358 assert(0 && "Call to dladdr() failed");
359
360 llvm::sys::Path CIndexPath(info.dli_fname);
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000361
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000362 // We now have the CIndex directory, locate clang relative to it.
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000363 CIndexPath.eraseComponent();
364 CIndexPath.eraseComponent();
365 CIndexPath.appendComponent("bin");
366 CIndexPath.appendComponent("clang");
John Thompson6a6742a2009-11-11 23:11:14 +0000367#endif
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000368
369 // Cache our result.
370 ClangPath = CIndexPath;
371 return ClangPath;
372}
373
374}
375
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000376static SourceLocation getLocationFromCursor(CXCursor C,
Daniel Dunbarc6190332009-11-08 04:13:53 +0000377 SourceManager &SourceMgr,
378 NamedDecl *ND) {
379 if (clang_isReference(C.kind)) {
380 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000381 case CXCursor_ObjCClassRef: {
382 if (isa<ObjCInterfaceDecl>(ND)) {
383 // FIXME: This is a hack (storing the parent decl in the stmt slot).
384 NamedDecl *parentDecl = static_cast<NamedDecl *>(C.stmt);
385 return parentDecl->getLocation();
Daniel Dunbarc6190332009-11-08 04:13:53 +0000386 }
Daniel Dunbaracca7252009-11-30 20:42:49 +0000387 ObjCCategoryDecl *OID = dyn_cast<ObjCCategoryDecl>(ND);
388 assert(OID && "clang_getCursorLine(): Missing category decl");
389 return OID->getClassInterface()->getLocation();
390 }
391 case CXCursor_ObjCSuperClassRef: {
392 ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(ND);
393 assert(OID && "clang_getCursorLine(): Missing interface decl");
394 return OID->getSuperClassLoc();
395 }
396 case CXCursor_ObjCProtocolRef: {
397 ObjCProtocolDecl *OID = dyn_cast<ObjCProtocolDecl>(ND);
398 assert(OID && "clang_getCursorLine(): Missing protocol decl");
399 return OID->getLocation();
400 }
401 case CXCursor_ObjCSelectorRef: {
402 ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(
403 static_cast<Stmt *>(C.stmt));
404 assert(OME && "clang_getCursorLine(): Missing message expr");
405 return OME->getLeftLoc(); /* FIXME: should be a range */
406 }
407 case CXCursor_VarRef:
408 case CXCursor_FunctionRef:
409 case CXCursor_EnumConstantRef: {
410 DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(
411 static_cast<Stmt *>(C.stmt));
412 assert(DRE && "clang_getCursorLine(): Missing decl ref expr");
413 return DRE->getLocation();
414 }
415 default:
416 return SourceLocation();
Daniel Dunbarc6190332009-11-08 04:13:53 +0000417 }
418 } else { // We have a declaration or a definition.
419 SourceLocation SLoc;
420 switch (ND->getKind()) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000421 case Decl::ObjCInterface: {
422 SLoc = dyn_cast<ObjCInterfaceDecl>(ND)->getClassLoc();
423 break;
424 }
425 case Decl::ObjCProtocol: {
426 SLoc = ND->getLocation(); /* FIXME: need to get the name location. */
427 break;
428 }
429 default: {
430 SLoc = ND->getLocation();
431 break;
432 }
Daniel Dunbarc6190332009-11-08 04:13:53 +0000433 }
434 if (SLoc.isInvalid())
435 return SourceLocation();
436 return SourceMgr.getSpellingLoc(SLoc); // handles macro instantiations.
437 }
438}
439
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000440static CXString createCXString(const char *String, bool DupString = false) {
441 CXString Str;
442 if (DupString) {
443 Str.Spelling = strdup(String);
444 Str.MustFreeString = 1;
445 } else {
446 Str.Spelling = String;
447 Str.MustFreeString = 0;
448 }
449 return Str;
450}
451
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000452extern "C" {
453
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000454CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000455 int displayDiagnostics) {
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000456 CIndexer *CIdxr = new CIndexer(new Program());
457 if (excludeDeclarationsFromPCH)
458 CIdxr->setOnlyLocalDecls();
459 if (displayDiagnostics)
460 CIdxr->setDisplayDiagnostics();
461 return CIdxr;
Steve Naroff600866c2009-08-27 19:51:58 +0000462}
463
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000464void clang_disposeIndex(CXIndex CIdx) {
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000465 assert(CIdx && "Passed null CXIndex");
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000466 delete static_cast<CIndexer *>(CIdx);
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000467}
468
Steve Naroff50398192009-08-28 15:28:48 +0000469// FIXME: need to pass back error info.
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000470CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
471 const char *ast_filename) {
Steve Naroff50398192009-08-28 15:28:48 +0000472 assert(CIdx && "Passed null CXIndex");
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000473 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000474
Daniel Dunbar5262fda2009-12-03 01:45:44 +0000475 return ASTUnit::LoadFromPCHFile(ast_filename, CXXIdx->getDiags(),
476 CXXIdx->getOnlyLocalDecls(),
477 /* UseBumpAllocator = */ true);
Steve Naroff600866c2009-08-27 19:51:58 +0000478}
479
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000480CXTranslationUnit
481clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
482 const char *source_filename,
483 int num_command_line_args,
484 const char **command_line_args) {
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000485 assert(CIdx && "Passed null CXIndex");
486 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
487
Ted Kremenek139ba862009-10-22 00:03:57 +0000488 // Build up the arguments for invoking 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000489 std::vector<const char *> argv;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000490
Ted Kremenek139ba862009-10-22 00:03:57 +0000491 // First add the complete path to the 'clang' executable.
492 llvm::sys::Path ClangPath = static_cast<CIndexer *>(CIdx)->getClangPath();
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000493 argv.push_back(ClangPath.c_str());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000494
Ted Kremenek139ba862009-10-22 00:03:57 +0000495 // Add the '-emit-ast' option as our execution mode for 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000496 argv.push_back("-emit-ast");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000497
Ted Kremenek139ba862009-10-22 00:03:57 +0000498 // The 'source_filename' argument is optional. If the caller does not
499 // specify it then it is assumed that the source file is specified
500 // in the actual argument list.
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000501 if (source_filename)
502 argv.push_back(source_filename);
Ted Kremenek139ba862009-10-22 00:03:57 +0000503
Steve Naroff37b5ac22009-10-15 20:50:09 +0000504 // Generate a temporary name for the AST file.
Ted Kremenek139ba862009-10-22 00:03:57 +0000505 argv.push_back("-o");
Steve Naroff37b5ac22009-10-15 20:50:09 +0000506 char astTmpFile[L_tmpnam];
Ted Kremenek74cd0692009-10-15 23:21:22 +0000507 argv.push_back(tmpnam(astTmpFile));
Ted Kremenek139ba862009-10-22 00:03:57 +0000508
509 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
510 for (int i = 0; i < num_command_line_args; ++i)
511 if (const char *arg = command_line_args[i]) {
512 if (strcmp(arg, "-o") == 0) {
513 ++i; // Also skip the matching argument.
514 continue;
515 }
516 if (strcmp(arg, "-emit-ast") == 0 ||
517 strcmp(arg, "-c") == 0 ||
518 strcmp(arg, "-fsyntax-only") == 0) {
519 continue;
520 }
521
522 // Keep the argument.
523 argv.push_back(arg);
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000524 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000525
Ted Kremenek139ba862009-10-22 00:03:57 +0000526 // Add the null terminator.
Ted Kremenek74cd0692009-10-15 23:21:22 +0000527 argv.push_back(NULL);
528
Ted Kremenekfeb15e32009-10-26 22:14:08 +0000529 // Invoke 'clang'.
530 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
531 // on Unix or NUL (Windows).
Ted Kremenek379afec2009-10-22 03:24:01 +0000532 std::string ErrMsg;
Ted Kremenekc46e4632009-10-19 22:27:32 +0000533 const llvm::sys::Path *Redirects[] = { &DevNull, &DevNull, &DevNull, NULL };
Ted Kremenek379afec2009-10-22 03:24:01 +0000534 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
535 /* redirects */ !CXXIdx->getDisplayDiagnostics() ? &Redirects[0] : NULL,
536 /* secondsToWait */ 0, /* memoryLimits */ 0, &ErrMsg);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000537
Ted Kremenek0854d702009-11-10 19:18:52 +0000538 if (CXXIdx->getDisplayDiagnostics() && !ErrMsg.empty()) {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000539 llvm::errs() << "clang_createTranslationUnitFromSourceFile: " << ErrMsg
Daniel Dunbaracca7252009-11-30 20:42:49 +0000540 << '\n' << "Arguments: \n";
Ted Kremenek379afec2009-10-22 03:24:01 +0000541 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
Ted Kremenek779e5f42009-10-26 22:08:39 +0000542 I!=E; ++I) {
543 if (*I)
544 llvm::errs() << ' ' << *I << '\n';
545 }
546 llvm::errs() << '\n';
Ted Kremenek379afec2009-10-22 03:24:01 +0000547 }
Benjamin Kramer0829a832009-10-18 11:19:36 +0000548
Steve Naroff37b5ac22009-10-15 20:50:09 +0000549 // Finally, we create the translation unit from the ast file.
Steve Naroffe19944c2009-10-15 22:23:48 +0000550 ASTUnit *ATU = static_cast<ASTUnit *>(
Daniel Dunbaracca7252009-11-30 20:42:49 +0000551 clang_createTranslationUnit(CIdx, astTmpFile));
Steve Naroffe56b4ba2009-10-20 14:46:24 +0000552 if (ATU)
553 ATU->unlinkTemporaryFile();
Steve Naroffe19944c2009-10-15 22:23:48 +0000554 return ATU;
Steve Naroff5b7d8e22009-10-15 20:04:39 +0000555}
556
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000557void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
Steve Naroff2bd6b9f2009-09-17 18:33:27 +0000558 assert(CTUnit && "Passed null CXTranslationUnit");
559 delete static_cast<ASTUnit *>(CTUnit);
560}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000561
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000562CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000563 assert(CTUnit && "Passed null CXTranslationUnit");
Steve Naroff77accc12009-09-03 18:19:54 +0000564 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000565 return createCXString(CXXUnit->getOriginalSourceFileName().c_str(), true);
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000566}
Daniel Dunbar1eb79b52009-08-28 16:30:07 +0000567
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000568void clang_loadTranslationUnit(CXTranslationUnit CTUnit,
Steve Naroffc857ea42009-09-02 13:28:54 +0000569 CXTranslationUnitIterator callback,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000570 CXClientData CData) {
Steve Naroff50398192009-08-28 15:28:48 +0000571 assert(CTUnit && "Passed null CXTranslationUnit");
572 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
573 ASTContext &Ctx = CXXUnit->getASTContext();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000574
575 TUVisitor DVisit(CTUnit, callback, CData,
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000576 CXXUnit->getOnlyLocalDecls()? 1 : Decl::MaxPCHLevel);
Steve Naroff50398192009-08-28 15:28:48 +0000577 DVisit.Visit(Ctx.getTranslationUnitDecl());
Steve Naroff600866c2009-08-27 19:51:58 +0000578}
579
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000580void clang_loadDeclaration(CXDecl Dcl,
581 CXDeclIterator callback,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000582 CXClientData CData) {
Steve Naroffc857ea42009-09-02 13:28:54 +0000583 assert(Dcl && "Passed null CXDecl");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000584
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000585 CDeclVisitor DVisit(Dcl, callback, CData,
586 static_cast<Decl *>(Dcl)->getPCHLevel());
Steve Naroffc857ea42009-09-02 13:28:54 +0000587 DVisit.Visit(static_cast<Decl *>(Dcl));
Steve Naroff600866c2009-08-27 19:51:58 +0000588}
589
Steve Naroff7e8f8182009-08-28 12:07:44 +0000590// Some notes on CXEntity:
591//
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000592// - Since the 'ordinary' namespace includes functions, data, typedefs,
593// ObjC interfaces, thecurrent algorithm is a bit naive (resulting in one
Steve Naroff7e8f8182009-08-28 12:07:44 +0000594// entity for 2 different types). For example:
595//
596// module1.m: @interface Foo @end Foo *x;
597// module2.m: void Foo(int);
598//
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000599// - Since the unique name spans translation units, static data/functions
Steve Naroff7e8f8182009-08-28 12:07:44 +0000600// within a CXTranslationUnit are *not* currently represented by entities.
601// As a result, there will be no entity for the following:
602//
603// module.m: static void Foo() { }
604//
605
606
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000607const char *clang_getDeclarationName(CXEntity) {
Steve Naroff600866c2009-08-27 19:51:58 +0000608 return "";
609}
610
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000611const char *clang_getURI(CXEntity) {
612 return "";
613}
614
615CXEntity clang_getEntity(const char *URI) {
Steve Naroff600866c2009-08-27 19:51:58 +0000616 return 0;
617}
618
619//
620// CXDecl Operations.
621//
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000622
623CXEntity clang_getEntityFromDecl(CXDecl) {
Steve Naroff600866c2009-08-27 19:51:58 +0000624 return 0;
625}
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000626
627CXString clang_getDeclSpelling(CXDecl AnonDecl) {
Steve Naroff89922f82009-08-31 00:59:03 +0000628 assert(AnonDecl && "Passed null CXDecl");
629 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
Steve Naroffef0cef62009-11-09 17:45:52 +0000630
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000631 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
632 return createCXString(OMD->getSelector().getAsString().c_str(), true);
633
634 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
Steve Naroff0d69b8c2009-10-29 21:11:04 +0000635 // No, this isn't the same as the code below. getIdentifier() is non-virtual
636 // and returns different names. NamedDecl returns the class name and
637 // ObjCCategoryImplDecl returns the category name.
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000638 return createCXString(CIMP->getIdentifier()->getNameStart());
639
640 if (ND->getIdentifier())
641 return createCXString(ND->getIdentifier()->getNameStart());
642
643 return createCXString("");
Steve Naroff600866c2009-08-27 19:51:58 +0000644}
Steve Narofff334b4e2009-09-02 18:26:48 +0000645
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000646unsigned clang_getDeclLine(CXDecl AnonDecl) {
Steve Naroff699a07d2009-09-25 21:32:34 +0000647 assert(AnonDecl && "Passed null CXDecl");
648 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
649 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
650 return SourceMgr.getSpellingLineNumber(ND->getLocation());
651}
652
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000653unsigned clang_getDeclColumn(CXDecl AnonDecl) {
Steve Naroff699a07d2009-09-25 21:32:34 +0000654 assert(AnonDecl && "Passed null CXDecl");
655 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
656 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Steve Naroff74165242009-09-25 22:15:54 +0000657 return SourceMgr.getSpellingColumnNumber(ND->getLocation());
Steve Naroff699a07d2009-09-25 21:32:34 +0000658}
659
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000660const char *clang_getDeclSource(CXDecl AnonDecl) {
Steve Naroffee9405e2009-09-25 21:45:39 +0000661 assert(AnonDecl && "Passed null CXDecl");
Steve Naroff88145032009-10-27 14:35:18 +0000662 FileEntry *FEnt = static_cast<FileEntry *>(clang_getDeclSourceFile(AnonDecl));
663 assert (FEnt && "Cannot find FileEntry for Decl");
664 return clang_getFileName(FEnt);
665}
666
667static const FileEntry *getFileEntryFromSourceLocation(SourceManager &SMgr,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000668 SourceLocation SLoc) {
Steve Naroff88145032009-10-27 14:35:18 +0000669 FileID FID;
670 if (SLoc.isFileID())
671 FID = SMgr.getFileID(SLoc);
672 else
673 FID = SMgr.getDecomposedSpellingLoc(SLoc).first;
674 return SMgr.getFileEntryForID(FID);
675}
676
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000677CXFile clang_getDeclSourceFile(CXDecl AnonDecl) {
Steve Naroff88145032009-10-27 14:35:18 +0000678 assert(AnonDecl && "Passed null CXDecl");
Steve Naroffee9405e2009-09-25 21:45:39 +0000679 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
680 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Steve Naroff88145032009-10-27 14:35:18 +0000681 return (void *)getFileEntryFromSourceLocation(SourceMgr, ND->getLocation());
682}
683
684const char *clang_getFileName(CXFile SFile) {
685 assert(SFile && "Passed null CXFile");
686 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
687 return FEnt->getName();
688}
689
690time_t clang_getFileTime(CXFile SFile) {
691 assert(SFile && "Passed null CXFile");
692 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
693 return FEnt->getModificationTime();
Steve Naroffee9405e2009-09-25 21:45:39 +0000694}
695
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000696CXString clang_getCursorSpelling(CXCursor C) {
Steve Narofff334b4e2009-09-02 18:26:48 +0000697 assert(C.decl && "CXCursor has null decl");
698 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
Steve Naroffef0cef62009-11-09 17:45:52 +0000699
Steve Narofff334b4e2009-09-02 18:26:48 +0000700 if (clang_isReference(C.kind)) {
701 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000702 case CXCursor_ObjCSuperClassRef: {
703 ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(ND);
704 assert(OID && "clang_getCursorLine(): Missing interface decl");
705 return createCXString(OID->getSuperClass()->getIdentifier()
706 ->getNameStart());
707 }
708 case CXCursor_ObjCClassRef: {
709 if (ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(ND))
Benjamin Kramer62cf3222009-11-09 19:13:48 +0000710 return createCXString(OID->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +0000711
712 ObjCCategoryDecl *OCD = dyn_cast<ObjCCategoryDecl>(ND);
713 assert(OCD && "clang_getCursorLine(): Missing category decl");
714 return createCXString(OCD->getClassInterface()->getIdentifier()
715 ->getNameStart());
716 }
717 case CXCursor_ObjCProtocolRef: {
718 ObjCProtocolDecl *OID = dyn_cast<ObjCProtocolDecl>(ND);
719 assert(OID && "clang_getCursorLine(): Missing protocol decl");
720 return createCXString(OID->getIdentifier()->getNameStart());
721 }
722 case CXCursor_ObjCSelectorRef: {
723 ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(
724 static_cast<Stmt *>(C.stmt));
725 assert(OME && "clang_getCursorLine(): Missing message expr");
726 return createCXString(OME->getSelector().getAsString().c_str(), true);
727 }
728 case CXCursor_VarRef:
729 case CXCursor_FunctionRef:
730 case CXCursor_EnumConstantRef: {
731 DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(
732 static_cast<Stmt *>(C.stmt));
733 assert(DRE && "clang_getCursorLine(): Missing decl ref expr");
734 return createCXString(DRE->getDecl()->getIdentifier()->getNameStart());
735 }
736 default:
737 return createCXString("<not implemented>");
Steve Narofff334b4e2009-09-02 18:26:48 +0000738 }
739 }
740 return clang_getDeclSpelling(C.decl);
741}
742
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000743const char *clang_getCursorKindSpelling(enum CXCursorKind Kind) {
Steve Naroff89922f82009-08-31 00:59:03 +0000744 switch (Kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000745 case CXCursor_FunctionDecl: return "FunctionDecl";
746 case CXCursor_TypedefDecl: return "TypedefDecl";
747 case CXCursor_EnumDecl: return "EnumDecl";
748 case CXCursor_EnumConstantDecl: return "EnumConstantDecl";
749 case CXCursor_StructDecl: return "StructDecl";
750 case CXCursor_UnionDecl: return "UnionDecl";
751 case CXCursor_ClassDecl: return "ClassDecl";
752 case CXCursor_FieldDecl: return "FieldDecl";
753 case CXCursor_VarDecl: return "VarDecl";
754 case CXCursor_ParmDecl: return "ParmDecl";
755 case CXCursor_ObjCInterfaceDecl: return "ObjCInterfaceDecl";
756 case CXCursor_ObjCCategoryDecl: return "ObjCCategoryDecl";
757 case CXCursor_ObjCProtocolDecl: return "ObjCProtocolDecl";
758 case CXCursor_ObjCPropertyDecl: return "ObjCPropertyDecl";
759 case CXCursor_ObjCIvarDecl: return "ObjCIvarDecl";
760 case CXCursor_ObjCInstanceMethodDecl: return "ObjCInstanceMethodDecl";
761 case CXCursor_ObjCClassMethodDecl: return "ObjCClassMethodDecl";
762 case CXCursor_FunctionDefn: return "FunctionDefn";
763 case CXCursor_ObjCInstanceMethodDefn: return "ObjCInstanceMethodDefn";
764 case CXCursor_ObjCClassMethodDefn: return "ObjCClassMethodDefn";
765 case CXCursor_ObjCClassDefn: return "ObjCClassDefn";
766 case CXCursor_ObjCCategoryDefn: return "ObjCCategoryDefn";
767 case CXCursor_ObjCSuperClassRef: return "ObjCSuperClassRef";
768 case CXCursor_ObjCProtocolRef: return "ObjCProtocolRef";
769 case CXCursor_ObjCClassRef: return "ObjCClassRef";
770 case CXCursor_ObjCSelectorRef: return "ObjCSelectorRef";
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000771
Daniel Dunbaracca7252009-11-30 20:42:49 +0000772 case CXCursor_VarRef: return "VarRef";
773 case CXCursor_FunctionRef: return "FunctionRef";
774 case CXCursor_EnumConstantRef: return "EnumConstantRef";
775 case CXCursor_MemberRef: return "MemberRef";
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000776
Daniel Dunbaracca7252009-11-30 20:42:49 +0000777 case CXCursor_InvalidFile: return "InvalidFile";
778 case CXCursor_NoDeclFound: return "NoDeclFound";
779 case CXCursor_NotImplemented: return "NotImplemented";
780 default: return "<not implemented>";
Steve Naroff89922f82009-08-31 00:59:03 +0000781 }
Steve Naroff600866c2009-08-27 19:51:58 +0000782}
Steve Naroff89922f82009-08-31 00:59:03 +0000783
Steve Naroff9efa7672009-09-04 15:44:05 +0000784static enum CXCursorKind TranslateKind(Decl *D) {
785 switch (D->getKind()) {
Daniel Dunbaracca7252009-11-30 20:42:49 +0000786 case Decl::Function: return CXCursor_FunctionDecl;
787 case Decl::Typedef: return CXCursor_TypedefDecl;
788 case Decl::Enum: return CXCursor_EnumDecl;
789 case Decl::EnumConstant: return CXCursor_EnumConstantDecl;
790 case Decl::Record: return CXCursor_StructDecl; // FIXME: union/class
791 case Decl::Field: return CXCursor_FieldDecl;
792 case Decl::Var: return CXCursor_VarDecl;
793 case Decl::ParmVar: return CXCursor_ParmDecl;
794 case Decl::ObjCInterface: return CXCursor_ObjCInterfaceDecl;
795 case Decl::ObjCCategory: return CXCursor_ObjCCategoryDecl;
796 case Decl::ObjCProtocol: return CXCursor_ObjCProtocolDecl;
797 case Decl::ObjCMethod: {
798 ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D);
799 if (MD->isInstanceMethod())
800 return CXCursor_ObjCInstanceMethodDecl;
801 return CXCursor_ObjCClassMethodDecl;
802 }
803 default: break;
Steve Naroff9efa7672009-09-04 15:44:05 +0000804 }
Steve Naroff77128dd2009-09-15 20:25:34 +0000805 return CXCursor_NotImplemented;
Steve Naroff9efa7672009-09-04 15:44:05 +0000806}
Steve Naroff600866c2009-08-27 19:51:58 +0000807//
808// CXCursor Operations.
809//
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000810
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000811CXCursor clang_getCursor(CXTranslationUnit CTUnit, const char *source_name,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000812 unsigned line, unsigned column) {
Steve Naroff9efa7672009-09-04 15:44:05 +0000813 assert(CTUnit && "Passed null CXTranslationUnit");
814 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000815
Steve Naroff9efa7672009-09-04 15:44:05 +0000816 FileManager &FMgr = CXXUnit->getFileManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000817 const FileEntry *File = FMgr.getFile(source_name,
818 source_name+strlen(source_name));
Steve Naroff77128dd2009-09-15 20:25:34 +0000819 if (!File) {
Steve Narofffb570422009-09-22 19:25:29 +0000820 CXCursor C = { CXCursor_InvalidFile, 0, 0 };
Steve Naroff77128dd2009-09-15 20:25:34 +0000821 return C;
822 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000823 SourceLocation SLoc =
Steve Naroff9efa7672009-09-04 15:44:05 +0000824 CXXUnit->getSourceManager().getLocation(File, line, column);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000825
Steve Narofff96b5242009-10-28 20:44:47 +0000826 ASTLocation LastLoc = CXXUnit->getLastASTLocation();
827
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000828 ASTLocation ALoc = ResolveLocationInAST(CXXUnit->getASTContext(), SLoc,
Steve Narofff96b5242009-10-28 20:44:47 +0000829 &LastLoc);
830 if (ALoc.isValid())
831 CXXUnit->setLastASTLocation(ALoc);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000832
Argyrios Kyrtzidisf4526e32009-09-29 19:44:27 +0000833 Decl *Dcl = ALoc.getParentDecl();
Argyrios Kyrtzidis05a76512009-09-29 19:45:58 +0000834 if (ALoc.isNamedRef())
835 Dcl = ALoc.AsNamedRef().ND;
Argyrios Kyrtzidisf4526e32009-09-29 19:44:27 +0000836 Stmt *Stm = ALoc.dyn_AsStmt();
Steve Naroff4ade6d62009-09-23 17:52:52 +0000837 if (Dcl) {
838 if (Stm) {
839 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Stm)) {
840 CXCursor C = { TranslateDeclRefExpr(DRE), Dcl, Stm };
841 return C;
842 } else if (ObjCMessageExpr *MExp = dyn_cast<ObjCMessageExpr>(Stm)) {
843 CXCursor C = { CXCursor_ObjCSelectorRef, Dcl, MExp };
844 return C;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000845 }
Steve Naroff4ade6d62009-09-23 17:52:52 +0000846 // Fall through...treat as a decl, not a ref.
847 }
Steve Naroff85e2db72009-10-01 00:31:07 +0000848 if (ALoc.isNamedRef()) {
849 if (isa<ObjCInterfaceDecl>(Dcl)) {
850 CXCursor C = { CXCursor_ObjCClassRef, Dcl, ALoc.getParentDecl() };
851 return C;
852 }
853 if (isa<ObjCProtocolDecl>(Dcl)) {
854 CXCursor C = { CXCursor_ObjCProtocolRef, Dcl, ALoc.getParentDecl() };
855 return C;
856 }
857 }
Daniel Dunbaracca7252009-11-30 20:42:49 +0000858 CXCursor C = { TranslateKind(Dcl), Dcl, 0 };
Steve Naroff77128dd2009-09-15 20:25:34 +0000859 return C;
860 }
Steve Narofffb570422009-09-22 19:25:29 +0000861 CXCursor C = { CXCursor_NoDeclFound, 0, 0 };
Steve Naroff9efa7672009-09-04 15:44:05 +0000862 return C;
Steve Naroff600866c2009-08-27 19:51:58 +0000863}
864
Ted Kremenek73885552009-11-17 19:28:59 +0000865CXCursor clang_getNullCursor(void) {
866 CXCursor C;
867 C.kind = CXCursor_InvalidFile;
868 C.decl = NULL;
869 C.stmt = NULL;
870 return C;
871}
872
873unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
874 return X.kind == Y.kind && X.decl == Y.decl && X.stmt == Y.stmt;
875}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000876
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000877CXCursor clang_getCursorFromDecl(CXDecl AnonDecl) {
Steve Naroff77128dd2009-09-15 20:25:34 +0000878 assert(AnonDecl && "Passed null CXDecl");
879 NamedDecl *ND = static_cast<NamedDecl *>(AnonDecl);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000880
Steve Narofffb570422009-09-22 19:25:29 +0000881 CXCursor C = { TranslateKind(ND), ND, 0 };
Steve Naroff77128dd2009-09-15 20:25:34 +0000882 return C;
883}
884
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000885unsigned clang_isInvalid(enum CXCursorKind K) {
Steve Naroff77128dd2009-09-15 20:25:34 +0000886 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
887}
888
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000889unsigned clang_isDeclaration(enum CXCursorKind K) {
Steve Naroff89922f82009-08-31 00:59:03 +0000890 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
891}
Steve Naroff2d4d6292009-08-31 14:26:51 +0000892
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000893unsigned clang_isReference(enum CXCursorKind K) {
Steve Narofff334b4e2009-09-02 18:26:48 +0000894 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
895}
896
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000897unsigned clang_isDefinition(enum CXCursorKind K) {
Steve Narofff334b4e2009-09-02 18:26:48 +0000898 return K >= CXCursor_FirstDefn && K <= CXCursor_LastDefn;
899}
900
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000901CXCursorKind clang_getCursorKind(CXCursor C) {
Steve Naroff9efa7672009-09-04 15:44:05 +0000902 return C.kind;
903}
904
Steve Naroff699a07d2009-09-25 21:32:34 +0000905static Decl *getDeclFromExpr(Stmt *E) {
906 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
907 return RefExpr->getDecl();
908 if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
909 return ME->getMemberDecl();
910 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
911 return RE->getDecl();
912
913 if (CallExpr *CE = dyn_cast<CallExpr>(E))
914 return getDeclFromExpr(CE->getCallee());
915 if (CastExpr *CE = dyn_cast<CastExpr>(E))
916 return getDeclFromExpr(CE->getSubExpr());
917 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
918 return OME->getMethodDecl();
919
920 return 0;
921}
922
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000923CXDecl clang_getCursorDecl(CXCursor C) {
Steve Naroff699a07d2009-09-25 21:32:34 +0000924 if (clang_isDeclaration(C.kind))
925 return C.decl;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000926
Steve Naroff699a07d2009-09-25 21:32:34 +0000927 if (clang_isReference(C.kind)) {
Steve Naroff85e2db72009-10-01 00:31:07 +0000928 if (C.stmt) {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000929 if (C.kind == CXCursor_ObjCClassRef ||
Steve Narofff9adf8f2009-10-05 17:58:19 +0000930 C.kind == CXCursor_ObjCProtocolRef)
Steve Naroff85e2db72009-10-01 00:31:07 +0000931 return static_cast<Stmt *>(C.stmt);
932 else
933 return getDeclFromExpr(static_cast<Stmt *>(C.stmt));
934 } else
Steve Naroff699a07d2009-09-25 21:32:34 +0000935 return C.decl;
936 }
937 return 0;
Steve Naroff9efa7672009-09-04 15:44:05 +0000938}
939
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000940unsigned clang_getCursorLine(CXCursor C) {
Steve Naroff2d4d6292009-08-31 14:26:51 +0000941 assert(C.decl && "CXCursor has null decl");
942 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
Steve Naroff2d4d6292009-08-31 14:26:51 +0000943 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000944
Steve Narofff334b4e2009-09-02 18:26:48 +0000945 SourceLocation SLoc = getLocationFromCursor(C, SourceMgr, ND);
Steve Naroff2d4d6292009-08-31 14:26:51 +0000946 return SourceMgr.getSpellingLineNumber(SLoc);
Steve Naroff600866c2009-08-27 19:51:58 +0000947}
Steve Narofff334b4e2009-09-02 18:26:48 +0000948
Steve Naroffef0cef62009-11-09 17:45:52 +0000949const char *clang_getCString(CXString string) {
950 return string.Spelling;
951}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000952
Steve Naroffef0cef62009-11-09 17:45:52 +0000953void clang_disposeString(CXString string) {
Benjamin Kramer858e5de2009-11-09 18:24:53 +0000954 if (string.MustFreeString)
955 free((void*)string.Spelling);
Steve Naroffef0cef62009-11-09 17:45:52 +0000956}
957
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000958unsigned clang_getCursorColumn(CXCursor C) {
Steve Naroff2d4d6292009-08-31 14:26:51 +0000959 assert(C.decl && "CXCursor has null decl");
960 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
Steve Naroff2d4d6292009-08-31 14:26:51 +0000961 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000962
Steve Narofff334b4e2009-09-02 18:26:48 +0000963 SourceLocation SLoc = getLocationFromCursor(C, SourceMgr, ND);
Steve Naroff2d4d6292009-08-31 14:26:51 +0000964 return SourceMgr.getSpellingColumnNumber(SLoc);
Steve Naroff600866c2009-08-27 19:51:58 +0000965}
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000966
967const char *clang_getCursorSource(CXCursor C) {
Steve Naroff2d4d6292009-08-31 14:26:51 +0000968 assert(C.decl && "CXCursor has null decl");
969 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
Steve Naroff2d4d6292009-08-31 14:26:51 +0000970 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000971
Steve Narofff334b4e2009-09-02 18:26:48 +0000972 SourceLocation SLoc = getLocationFromCursor(C, SourceMgr, ND);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000973
Ted Kremenek9298cfc2009-11-17 05:31:58 +0000974 if (SLoc.isFileID()) {
975 const char *bufferName = SourceMgr.getBufferName(SLoc);
976 return bufferName[0] == '<' ? NULL : bufferName;
977 }
Douglas Gregor02465752009-10-16 21:24:31 +0000978
979 // Retrieve the file in which the macro was instantiated, then provide that
980 // buffer name.
981 // FIXME: Do we want to give specific macro-instantiation information?
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000982 const llvm::MemoryBuffer *Buffer
Douglas Gregor02465752009-10-16 21:24:31 +0000983 = SourceMgr.getBuffer(SourceMgr.getDecomposedSpellingLoc(SLoc).first);
984 if (!Buffer)
985 return 0;
986
987 return Buffer->getBufferIdentifier();
Steve Naroff600866c2009-08-27 19:51:58 +0000988}
989
Daniel Dunbar9ebfa312009-12-01 03:14:51 +0000990CXFile clang_getCursorSourceFile(CXCursor C) {
Steve Naroff88145032009-10-27 14:35:18 +0000991 assert(C.decl && "CXCursor has null decl");
992 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
993 SourceManager &SourceMgr = ND->getASTContext().getSourceManager();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000994
Steve Naroff88145032009-10-27 14:35:18 +0000995 return (void *)getFileEntryFromSourceLocation(SourceMgr,
Daniel Dunbaracca7252009-11-30 20:42:49 +0000996 getLocationFromCursor(C,SourceMgr, ND));
Steve Naroff88145032009-10-27 14:35:18 +0000997}
998
Daniel Dunbar0d7dd222009-11-30 20:42:43 +0000999void clang_getDefinitionSpellingAndExtent(CXCursor C,
Steve Naroff4ade6d62009-09-23 17:52:52 +00001000 const char **startBuf,
1001 const char **endBuf,
1002 unsigned *startLine,
1003 unsigned *startColumn,
1004 unsigned *endLine,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001005 unsigned *endColumn) {
Steve Naroff4ade6d62009-09-23 17:52:52 +00001006 assert(C.decl && "CXCursor has null decl");
1007 NamedDecl *ND = static_cast<NamedDecl *>(C.decl);
1008 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
1009 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001010
Steve Naroff4ade6d62009-09-23 17:52:52 +00001011 SourceManager &SM = FD->getASTContext().getSourceManager();
1012 *startBuf = SM.getCharacterData(Body->getLBracLoc());
1013 *endBuf = SM.getCharacterData(Body->getRBracLoc());
1014 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
1015 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
1016 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
1017 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
1018}
1019
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001020enum CXCompletionChunkKind
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001021clang_getCompletionChunkKind(CXCompletionString completion_string,
1022 unsigned chunk_number) {
1023 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1024 if (!CCStr || chunk_number >= CCStr->size())
1025 return CXCompletionChunk_Text;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001026
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001027 switch ((*CCStr)[chunk_number].Kind) {
1028 case CodeCompletionString::CK_TypedText:
1029 return CXCompletionChunk_TypedText;
1030 case CodeCompletionString::CK_Text:
1031 return CXCompletionChunk_Text;
1032 case CodeCompletionString::CK_Optional:
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001033 return CXCompletionChunk_Optional;
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001034 case CodeCompletionString::CK_Placeholder:
1035 return CXCompletionChunk_Placeholder;
1036 case CodeCompletionString::CK_Informative:
1037 return CXCompletionChunk_Informative;
1038 case CodeCompletionString::CK_CurrentParameter:
1039 return CXCompletionChunk_CurrentParameter;
1040 case CodeCompletionString::CK_LeftParen:
1041 return CXCompletionChunk_LeftParen;
1042 case CodeCompletionString::CK_RightParen:
1043 return CXCompletionChunk_RightParen;
1044 case CodeCompletionString::CK_LeftBracket:
1045 return CXCompletionChunk_LeftBracket;
1046 case CodeCompletionString::CK_RightBracket:
1047 return CXCompletionChunk_RightBracket;
1048 case CodeCompletionString::CK_LeftBrace:
1049 return CXCompletionChunk_LeftBrace;
1050 case CodeCompletionString::CK_RightBrace:
1051 return CXCompletionChunk_RightBrace;
1052 case CodeCompletionString::CK_LeftAngle:
1053 return CXCompletionChunk_LeftAngle;
1054 case CodeCompletionString::CK_RightAngle:
1055 return CXCompletionChunk_RightAngle;
1056 case CodeCompletionString::CK_Comma:
1057 return CXCompletionChunk_Comma;
1058 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001059
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001060 // Should be unreachable, but let's be careful.
1061 return CXCompletionChunk_Text;
1062}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001063
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001064const char *clang_getCompletionChunkText(CXCompletionString completion_string,
1065 unsigned chunk_number) {
1066 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1067 if (!CCStr || chunk_number >= CCStr->size())
1068 return 0;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001069
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001070 switch ((*CCStr)[chunk_number].Kind) {
1071 case CodeCompletionString::CK_TypedText:
1072 case CodeCompletionString::CK_Text:
1073 case CodeCompletionString::CK_Placeholder:
1074 case CodeCompletionString::CK_CurrentParameter:
1075 case CodeCompletionString::CK_Informative:
1076 case CodeCompletionString::CK_LeftParen:
1077 case CodeCompletionString::CK_RightParen:
1078 case CodeCompletionString::CK_LeftBracket:
1079 case CodeCompletionString::CK_RightBracket:
1080 case CodeCompletionString::CK_LeftBrace:
1081 case CodeCompletionString::CK_RightBrace:
1082 case CodeCompletionString::CK_LeftAngle:
1083 case CodeCompletionString::CK_RightAngle:
1084 case CodeCompletionString::CK_Comma:
1085 return (*CCStr)[chunk_number].Text;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001086
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001087 case CodeCompletionString::CK_Optional:
1088 // Note: treated as an empty text block.
1089 return 0;
1090 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001091
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001092 // Should be unreachable, but let's be careful.
1093 return 0;
1094}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001095
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001096CXCompletionString
1097clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
1098 unsigned chunk_number) {
1099 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1100 if (!CCStr || chunk_number >= CCStr->size())
1101 return 0;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001102
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001103 switch ((*CCStr)[chunk_number].Kind) {
1104 case CodeCompletionString::CK_TypedText:
1105 case CodeCompletionString::CK_Text:
1106 case CodeCompletionString::CK_Placeholder:
1107 case CodeCompletionString::CK_CurrentParameter:
1108 case CodeCompletionString::CK_Informative:
1109 case CodeCompletionString::CK_LeftParen:
1110 case CodeCompletionString::CK_RightParen:
1111 case CodeCompletionString::CK_LeftBracket:
1112 case CodeCompletionString::CK_RightBracket:
1113 case CodeCompletionString::CK_LeftBrace:
1114 case CodeCompletionString::CK_RightBrace:
1115 case CodeCompletionString::CK_LeftAngle:
1116 case CodeCompletionString::CK_RightAngle:
1117 case CodeCompletionString::CK_Comma:
1118 return 0;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001119
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001120 case CodeCompletionString::CK_Optional:
1121 // Note: treated as an empty text block.
1122 return (*CCStr)[chunk_number].Optional;
1123 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001124
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001125 // Should be unreachable, but let's be careful.
1126 return 0;
1127}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001128
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001129unsigned clang_getNumCompletionChunks(CXCompletionString completion_string) {
1130 CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
1131 return CCStr? CCStr->size() : 0;
1132}
Steve Naroff4ade6d62009-09-23 17:52:52 +00001133
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001134static bool ReadUnsigned(const char *&Memory, const char *MemoryEnd,
1135 unsigned &Value) {
1136 if (Memory + sizeof(unsigned) > MemoryEnd)
1137 return true;
1138
1139 memmove(&Value, Memory, sizeof(unsigned));
1140 Memory += sizeof(unsigned);
1141 return false;
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001142}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001143
1144void clang_codeComplete(CXIndex CIdx,
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001145 const char *source_filename,
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001146 int num_command_line_args,
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001147 const char **command_line_args,
Douglas Gregor735df882009-12-02 09:21:34 +00001148 unsigned num_unsaved_files,
1149 struct CXUnsavedFile *unsaved_files,
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001150 const char *complete_filename,
1151 unsigned complete_line,
1152 unsigned complete_column,
1153 CXCompletionIterator completion_iterator,
1154 CXClientData client_data) {
1155 // The indexer, which is mainly used to determine where diagnostics go.
1156 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001157
Douglas Gregor735df882009-12-02 09:21:34 +00001158 // The set of temporary files that we've built.
1159 std::vector<llvm::sys::Path> TemporaryFiles;
1160
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001161 // Build up the arguments for invoking 'clang'.
1162 std::vector<const char *> argv;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001163
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001164 // First add the complete path to the 'clang' executable.
1165 llvm::sys::Path ClangPath = CXXIdx->getClangPath();
1166 argv.push_back(ClangPath.c_str());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001167
1168 // Add the '-fsyntax-only' argument so that we only perform a basic
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001169 // syntax check of the code.
1170 argv.push_back("-fsyntax-only");
1171
1172 // Add the appropriate '-code-completion-at=file:line:column' argument
1173 // to perform code completion, with an "-Xclang" preceding it.
1174 std::string code_complete_at;
1175 code_complete_at += "-code-completion-at=";
1176 code_complete_at += complete_filename;
1177 code_complete_at += ":";
1178 code_complete_at += llvm::utostr(complete_line);
1179 code_complete_at += ":";
1180 code_complete_at += llvm::utostr(complete_column);
1181 argv.push_back("-Xclang");
1182 argv.push_back(code_complete_at.c_str());
1183 argv.push_back("-Xclang");
Daniel Dunbar4db166b2009-11-19 05:32:09 +00001184 argv.push_back("-no-code-completion-debug-printer");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001185
Douglas Gregor735df882009-12-02 09:21:34 +00001186 std::vector<std::string> RemapArgs;
1187 for (unsigned i = 0; i != num_unsaved_files; ++i) {
1188 char tmpFile[L_tmpnam];
1189 char *tmpFileName = tmpnam(tmpFile);
1190
1191 // Write the contents of this unsaved file into the temporary file.
1192 llvm::sys::Path SavedFile(tmpFileName);
1193 std::string ErrorInfo;
1194 llvm::raw_fd_ostream OS(SavedFile.c_str(), ErrorInfo);
1195 if (!ErrorInfo.empty())
1196 continue;
1197
1198 OS.write(unsaved_files[i].Contents, unsaved_files[i].Length);
1199 OS.close();
1200 if (OS.has_error()) {
1201 SavedFile.eraseFromDisk();
1202 continue;
1203 }
1204
1205 // Remap the file.
1206 std::string RemapArg = "-remap-file=";
1207 RemapArg += unsaved_files[i].Filename;
1208 RemapArg += ';';
1209 RemapArg += tmpFileName;
1210 RemapArgs.push_back("-Xclang");
1211 RemapArgs.push_back(RemapArg);
1212 TemporaryFiles.push_back(SavedFile);
1213 }
1214
1215 // The pointers into the elements of RemapArgs are stable because we
1216 // won't be adding anything to RemapArgs after this point.
1217 for (unsigned i = 0, e = RemapArgs.size(); i != e; ++i)
1218 argv.push_back(RemapArgs[i].c_str());
1219
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001220 // Add the source file name (FIXME: later, we'll want to build temporary
1221 // file from the buffer, or just feed the source text via standard input).
Ted Kremenek4633d1b2009-11-17 18:18:02 +00001222 if (source_filename)
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001223 argv.push_back(source_filename);
1224
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001225 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
1226 for (int i = 0; i < num_command_line_args; ++i)
1227 if (const char *arg = command_line_args[i]) {
1228 if (strcmp(arg, "-o") == 0) {
1229 ++i; // Also skip the matching argument.
1230 continue;
1231 }
1232 if (strcmp(arg, "-emit-ast") == 0 ||
1233 strcmp(arg, "-c") == 0 ||
1234 strcmp(arg, "-fsyntax-only") == 0) {
1235 continue;
1236 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001237
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001238 // Keep the argument.
1239 argv.push_back(arg);
1240 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001241
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001242 // Add the null terminator.
1243 argv.push_back(NULL);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001244
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001245 // Generate a temporary name for the AST file.
1246 char tmpFile[L_tmpnam];
1247 char *tmpFileName = tmpnam(tmpFile);
1248 llvm::sys::Path ResultsFile(tmpFileName);
Douglas Gregor735df882009-12-02 09:21:34 +00001249 TemporaryFiles.push_back(ResultsFile);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001250
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001251 // Invoke 'clang'.
1252 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
1253 // on Unix or NUL (Windows).
1254 std::string ErrMsg;
1255 const llvm::sys::Path *Redirects[] = { &DevNull, &ResultsFile, &DevNull, 0 };
1256 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
1257 /* redirects */ &Redirects[0],
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001258 /* secondsToWait */ 0,
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001259 /* memoryLimits */ 0, &ErrMsg);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001260
Ted Kremenek0854d702009-11-10 19:18:52 +00001261 if (CXXIdx->getDisplayDiagnostics() && !ErrMsg.empty()) {
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001262 llvm::errs() << "clang_codeComplete: " << ErrMsg
Daniel Dunbaracca7252009-11-30 20:42:49 +00001263 << '\n' << "Arguments: \n";
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001264 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
1265 I!=E; ++I) {
1266 if (*I)
1267 llvm::errs() << ' ' << *I << '\n';
1268 }
1269 llvm::errs() << '\n';
1270 }
1271
1272 // Parse the resulting source file to find code-completion results.
1273 using llvm::MemoryBuffer;
1274 using llvm::StringRef;
1275 if (MemoryBuffer *F = MemoryBuffer::getFile(ResultsFile.c_str())) {
1276 StringRef Buffer = F->getBuffer();
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001277 for (const char *Str = Buffer.data(), *StrEnd = Str + Buffer.size();
1278 Str < StrEnd;) {
1279 unsigned KindValue;
1280 if (ReadUnsigned(Str, StrEnd, KindValue))
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001281 break;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001282
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001283 CodeCompletionString *CCStr
1284 = CodeCompletionString::Deserialize(Str, StrEnd);
1285 if (!CCStr)
1286 continue;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001287
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001288 if (!CCStr->empty()) {
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001289 // Vend the code-completion result to the caller.
1290 CXCompletionResult Result;
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001291 Result.CursorKind = (CXCursorKind)KindValue;
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001292 Result.CompletionString = CCStr;
1293 if (completion_iterator)
1294 completion_iterator(&Result, client_data);
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001295 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001296
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001297 delete CCStr;
Douglas Gregor2b4074f2009-12-01 05:55:20 +00001298 };
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001299 delete F;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001300 }
1301
Douglas Gregor735df882009-12-02 09:21:34 +00001302 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i)
1303 TemporaryFiles[i].eraseFromDisk();
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001304}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001305
Steve Naroff600866c2009-08-27 19:51:58 +00001306} // end extern "C"