blob: d591c5defb2e480799f51362d10f2cac018c0615 [file] [log] [blame]
Ted Kremenekab188932010-01-05 19:32:54 +00001//===- CIndexCodeCompletion.cpp - Code Completion API hooks ---------------===//
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.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the Clang-C Source Indexing library hooks for
11// code completion.
12//
13//===----------------------------------------------------------------------===//
14
15#include "CIndexer.h"
Douglas Gregor936ea3b2010-01-28 00:56:43 +000016#include "CIndexDiagnostic.h"
Benjamin Kramerb846deb2010-04-12 19:45:50 +000017#include "clang/Basic/SourceManager.h"
18#include "clang/Basic/FileManager.h"
Douglas Gregor1abc6bc2010-08-04 16:47:14 +000019#include "clang/Frontend/ASTUnit.h"
Benjamin Kramerb846deb2010-04-12 19:45:50 +000020#include "clang/Frontend/CompilerInstance.h"
Douglas Gregor936ea3b2010-01-28 00:56:43 +000021#include "clang/Frontend/FrontendDiagnostic.h"
Ted Kremenekab188932010-01-05 19:32:54 +000022#include "clang/Sema/CodeCompleteConsumer.h"
Douglas Gregordf95a132010-08-09 20:45:32 +000023#include "llvm/ADT/SmallString.h"
Ted Kremenekab188932010-01-05 19:32:54 +000024#include "llvm/ADT/StringExtras.h"
Daniel Dunbarb1fd3452010-08-19 23:44:10 +000025#include "llvm/Support/CrashRecoveryContext.h"
Ted Kremenekab188932010-01-05 19:32:54 +000026#include "llvm/Support/MemoryBuffer.h"
Douglas Gregordf95a132010-08-09 20:45:32 +000027#include "llvm/Support/Timer.h"
28#include "llvm/Support/raw_ostream.h"
Ted Kremenekab188932010-01-05 19:32:54 +000029#include "llvm/System/Program.h"
Douglas Gregor3d398aa2010-07-26 16:29:14 +000030#include <cstdlib>
31#include <cstdio>
Ted Kremenekab188932010-01-05 19:32:54 +000032
Douglas Gregordf95a132010-08-09 20:45:32 +000033
Ted Kremenekda7af322010-04-15 01:02:28 +000034#ifdef UDP_CODE_COMPLETION_LOGGER
35#include "clang/Basic/Version.h"
Ted Kremenekda7af322010-04-15 01:02:28 +000036#include <arpa/inet.h>
37#include <sys/socket.h>
38#include <sys/types.h>
39#include <unistd.h>
40#endif
41
Ted Kremenekab188932010-01-05 19:32:54 +000042using namespace clang;
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +000043using namespace clang::cxstring;
Ted Kremenekab188932010-01-05 19:32:54 +000044
Douglas Gregor12e13132010-05-26 22:00:08 +000045namespace {
46 /// \brief Stored representation of a completion string.
47 ///
48 /// This is the representation behind a CXCompletionString.
49 class CXStoredCodeCompletionString : public CodeCompletionString {
50 unsigned Priority;
Douglas Gregor58ddb602010-08-23 23:00:57 +000051 CXAvailabilityKind Availability;
Douglas Gregor12e13132010-05-26 22:00:08 +000052
53 public:
Douglas Gregor58ddb602010-08-23 23:00:57 +000054 CXStoredCodeCompletionString(unsigned Priority,
55 CXAvailabilityKind Availability)
56 : Priority(Priority), Availability(Availability) { }
Douglas Gregor12e13132010-05-26 22:00:08 +000057
58 unsigned getPriority() const { return Priority; }
Douglas Gregor58ddb602010-08-23 23:00:57 +000059 CXAvailabilityKind getAvailability() const { return Availability; }
Douglas Gregor12e13132010-05-26 22:00:08 +000060 };
61}
62
Ted Kremenekab188932010-01-05 19:32:54 +000063extern "C" {
64
65enum CXCompletionChunkKind
66clang_getCompletionChunkKind(CXCompletionString completion_string,
67 unsigned chunk_number) {
Douglas Gregor12e13132010-05-26 22:00:08 +000068 CXStoredCodeCompletionString *CCStr
69 = (CXStoredCodeCompletionString *)completion_string;
Ted Kremenekab188932010-01-05 19:32:54 +000070 if (!CCStr || chunk_number >= CCStr->size())
71 return CXCompletionChunk_Text;
72
73 switch ((*CCStr)[chunk_number].Kind) {
74 case CodeCompletionString::CK_TypedText:
75 return CXCompletionChunk_TypedText;
76 case CodeCompletionString::CK_Text:
77 return CXCompletionChunk_Text;
78 case CodeCompletionString::CK_Optional:
79 return CXCompletionChunk_Optional;
80 case CodeCompletionString::CK_Placeholder:
81 return CXCompletionChunk_Placeholder;
82 case CodeCompletionString::CK_Informative:
83 return CXCompletionChunk_Informative;
84 case CodeCompletionString::CK_ResultType:
85 return CXCompletionChunk_ResultType;
86 case CodeCompletionString::CK_CurrentParameter:
87 return CXCompletionChunk_CurrentParameter;
88 case CodeCompletionString::CK_LeftParen:
89 return CXCompletionChunk_LeftParen;
90 case CodeCompletionString::CK_RightParen:
91 return CXCompletionChunk_RightParen;
92 case CodeCompletionString::CK_LeftBracket:
93 return CXCompletionChunk_LeftBracket;
94 case CodeCompletionString::CK_RightBracket:
95 return CXCompletionChunk_RightBracket;
96 case CodeCompletionString::CK_LeftBrace:
97 return CXCompletionChunk_LeftBrace;
98 case CodeCompletionString::CK_RightBrace:
99 return CXCompletionChunk_RightBrace;
100 case CodeCompletionString::CK_LeftAngle:
101 return CXCompletionChunk_LeftAngle;
102 case CodeCompletionString::CK_RightAngle:
103 return CXCompletionChunk_RightAngle;
104 case CodeCompletionString::CK_Comma:
105 return CXCompletionChunk_Comma;
Douglas Gregor01dfea02010-01-10 23:08:15 +0000106 case CodeCompletionString::CK_Colon:
107 return CXCompletionChunk_Colon;
108 case CodeCompletionString::CK_SemiColon:
109 return CXCompletionChunk_SemiColon;
110 case CodeCompletionString::CK_Equal:
111 return CXCompletionChunk_Equal;
112 case CodeCompletionString::CK_HorizontalSpace:
113 return CXCompletionChunk_HorizontalSpace;
114 case CodeCompletionString::CK_VerticalSpace:
115 return CXCompletionChunk_VerticalSpace;
Ted Kremenekab188932010-01-05 19:32:54 +0000116 }
117
118 // Should be unreachable, but let's be careful.
119 return CXCompletionChunk_Text;
120}
121
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000122CXString clang_getCompletionChunkText(CXCompletionString completion_string,
123 unsigned chunk_number) {
Douglas Gregor12e13132010-05-26 22:00:08 +0000124 CXStoredCodeCompletionString *CCStr
125 = (CXStoredCodeCompletionString *)completion_string;
Ted Kremenekab188932010-01-05 19:32:54 +0000126 if (!CCStr || chunk_number >= CCStr->size())
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000127 return createCXString(0);
Ted Kremenekab188932010-01-05 19:32:54 +0000128
129 switch ((*CCStr)[chunk_number].Kind) {
130 case CodeCompletionString::CK_TypedText:
131 case CodeCompletionString::CK_Text:
132 case CodeCompletionString::CK_Placeholder:
133 case CodeCompletionString::CK_CurrentParameter:
134 case CodeCompletionString::CK_Informative:
135 case CodeCompletionString::CK_LeftParen:
136 case CodeCompletionString::CK_RightParen:
137 case CodeCompletionString::CK_LeftBracket:
138 case CodeCompletionString::CK_RightBracket:
139 case CodeCompletionString::CK_LeftBrace:
140 case CodeCompletionString::CK_RightBrace:
141 case CodeCompletionString::CK_LeftAngle:
142 case CodeCompletionString::CK_RightAngle:
143 case CodeCompletionString::CK_Comma:
144 case CodeCompletionString::CK_ResultType:
Douglas Gregor01dfea02010-01-10 23:08:15 +0000145 case CodeCompletionString::CK_Colon:
146 case CodeCompletionString::CK_SemiColon:
147 case CodeCompletionString::CK_Equal:
148 case CodeCompletionString::CK_HorizontalSpace:
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000149 return createCXString((*CCStr)[chunk_number].Text, false);
Ted Kremenekab188932010-01-05 19:32:54 +0000150
Douglas Gregor21c241f2010-05-25 06:14:46 +0000151 case CodeCompletionString::CK_VerticalSpace:
152 // FIXME: Temporary hack until we figure out how to handle vertical space.
153 return createCXString(" ");
154
Ted Kremenekab188932010-01-05 19:32:54 +0000155 case CodeCompletionString::CK_Optional:
156 // Note: treated as an empty text block.
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000157 return createCXString("");
Ted Kremenekab188932010-01-05 19:32:54 +0000158 }
159
160 // Should be unreachable, but let's be careful.
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000161 return createCXString(0);
Ted Kremenekab188932010-01-05 19:32:54 +0000162}
163
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000164
Ted Kremenekab188932010-01-05 19:32:54 +0000165CXCompletionString
166clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
167 unsigned chunk_number) {
Douglas Gregor12e13132010-05-26 22:00:08 +0000168 CXStoredCodeCompletionString *CCStr
169 = (CXStoredCodeCompletionString *)completion_string;
Ted Kremenekab188932010-01-05 19:32:54 +0000170 if (!CCStr || chunk_number >= CCStr->size())
171 return 0;
172
173 switch ((*CCStr)[chunk_number].Kind) {
174 case CodeCompletionString::CK_TypedText:
175 case CodeCompletionString::CK_Text:
176 case CodeCompletionString::CK_Placeholder:
177 case CodeCompletionString::CK_CurrentParameter:
178 case CodeCompletionString::CK_Informative:
179 case CodeCompletionString::CK_LeftParen:
180 case CodeCompletionString::CK_RightParen:
181 case CodeCompletionString::CK_LeftBracket:
182 case CodeCompletionString::CK_RightBracket:
183 case CodeCompletionString::CK_LeftBrace:
184 case CodeCompletionString::CK_RightBrace:
185 case CodeCompletionString::CK_LeftAngle:
186 case CodeCompletionString::CK_RightAngle:
187 case CodeCompletionString::CK_Comma:
188 case CodeCompletionString::CK_ResultType:
Douglas Gregor01dfea02010-01-10 23:08:15 +0000189 case CodeCompletionString::CK_Colon:
190 case CodeCompletionString::CK_SemiColon:
191 case CodeCompletionString::CK_Equal:
192 case CodeCompletionString::CK_HorizontalSpace:
193 case CodeCompletionString::CK_VerticalSpace:
Ted Kremenekab188932010-01-05 19:32:54 +0000194 return 0;
195
196 case CodeCompletionString::CK_Optional:
197 // Note: treated as an empty text block.
198 return (*CCStr)[chunk_number].Optional;
199 }
200
201 // Should be unreachable, but let's be careful.
202 return 0;
203}
204
205unsigned clang_getNumCompletionChunks(CXCompletionString completion_string) {
Douglas Gregor12e13132010-05-26 22:00:08 +0000206 CXStoredCodeCompletionString *CCStr
207 = (CXStoredCodeCompletionString *)completion_string;
Ted Kremenekab188932010-01-05 19:32:54 +0000208 return CCStr? CCStr->size() : 0;
209}
210
Douglas Gregor12e13132010-05-26 22:00:08 +0000211unsigned clang_getCompletionPriority(CXCompletionString completion_string) {
212 CXStoredCodeCompletionString *CCStr
213 = (CXStoredCodeCompletionString *)completion_string;
Bill Wendlinga2ace582010-05-27 18:35:05 +0000214 return CCStr? CCStr->getPriority() : unsigned(CCP_Unlikely);
Douglas Gregor12e13132010-05-26 22:00:08 +0000215}
216
Douglas Gregor58ddb602010-08-23 23:00:57 +0000217enum CXAvailabilityKind
218clang_getCompletionAvailability(CXCompletionString completion_string) {
219 CXStoredCodeCompletionString *CCStr
220 = (CXStoredCodeCompletionString *)completion_string;
221 return CCStr? CCStr->getAvailability() : CXAvailability_Available;
222}
223
Ted Kremenekab188932010-01-05 19:32:54 +0000224static bool ReadUnsigned(const char *&Memory, const char *MemoryEnd,
225 unsigned &Value) {
226 if (Memory + sizeof(unsigned) > MemoryEnd)
227 return true;
228
229 memmove(&Value, Memory, sizeof(unsigned));
230 Memory += sizeof(unsigned);
231 return false;
232}
233
234/// \brief The CXCodeCompleteResults structure we allocate internally;
235/// the client only sees the initial CXCodeCompleteResults structure.
236struct AllocatedCXCodeCompleteResults : public CXCodeCompleteResults {
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000237 AllocatedCXCodeCompleteResults();
238 ~AllocatedCXCodeCompleteResults();
239
Douglas Gregora88084b2010-02-18 18:08:43 +0000240 /// \brief Diagnostics produced while performing code completion.
241 llvm::SmallVector<StoredDiagnostic, 8> Diagnostics;
242
Douglas Gregorf715ca12010-03-16 00:06:06 +0000243 /// \brief Diag object
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000244 llvm::IntrusiveRefCntPtr<Diagnostic> Diag;
Douglas Gregorf715ca12010-03-16 00:06:06 +0000245
Douglas Gregora88084b2010-02-18 18:08:43 +0000246 /// \brief Language options used to adjust source locations.
Daniel Dunbar35b84402010-01-30 23:31:40 +0000247 LangOptions LangOpts;
Douglas Gregora88084b2010-02-18 18:08:43 +0000248
249 /// \brief Source manager, used for diagnostics.
250 SourceManager SourceMgr;
251
252 /// \brief File manager, used for diagnostics.
253 FileManager FileMgr;
Douglas Gregor313e26c2010-02-18 23:35:40 +0000254
255 /// \brief Temporary files that should be removed once we have finished
256 /// with the code-completion results.
257 std::vector<llvm::sys::Path> TemporaryFiles;
Douglas Gregorb75d3df2010-08-04 17:07:00 +0000258
259 /// \brief Temporary buffers that will be deleted once we have finished with the code-completion results.
260 llvm::SmallVector<const llvm::MemoryBuffer *, 1> TemporaryBuffers;
Ted Kremenekab188932010-01-05 19:32:54 +0000261};
262
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000263AllocatedCXCodeCompleteResults::AllocatedCXCodeCompleteResults()
Douglas Gregorb75d3df2010-08-04 17:07:00 +0000264 : CXCodeCompleteResults(), Diag(new Diagnostic), SourceMgr(*Diag) { }
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000265
266AllocatedCXCodeCompleteResults::~AllocatedCXCodeCompleteResults() {
267 for (unsigned I = 0, N = NumResults; I != N; ++I)
Douglas Gregor12e13132010-05-26 22:00:08 +0000268 delete (CXStoredCodeCompletionString *)Results[I].CompletionString;
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000269 delete [] Results;
Douglas Gregor313e26c2010-02-18 23:35:40 +0000270
271 for (unsigned I = 0, N = TemporaryFiles.size(); I != N; ++I)
272 TemporaryFiles[I].eraseFromDisk();
Douglas Gregorb75d3df2010-08-04 17:07:00 +0000273 for (unsigned I = 0, N = TemporaryBuffers.size(); I != N; ++I)
274 delete TemporaryBuffers[I];
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000275}
276
Ted Kremenekab188932010-01-05 19:32:54 +0000277CXCodeCompleteResults *clang_codeComplete(CXIndex CIdx,
278 const char *source_filename,
279 int num_command_line_args,
Douglas Gregor2ef69442010-09-01 16:43:19 +0000280 const char * const *command_line_args,
Ted Kremenekab188932010-01-05 19:32:54 +0000281 unsigned num_unsaved_files,
282 struct CXUnsavedFile *unsaved_files,
283 const char *complete_filename,
284 unsigned complete_line,
Douglas Gregora88084b2010-02-18 18:08:43 +0000285 unsigned complete_column) {
Ted Kremenekda7af322010-04-15 01:02:28 +0000286#ifdef UDP_CODE_COMPLETION_LOGGER
287#ifdef UDP_CODE_COMPLETION_LOGGER_PORT
288 const llvm::TimeRecord &StartTime = llvm::TimeRecord::getCurrentTime();
289#endif
290#endif
291
Douglas Gregor3d398aa2010-07-26 16:29:14 +0000292 bool EnableLogging = getenv("LIBCLANG_CODE_COMPLETION_LOGGING") != 0;
Douglas Gregordf95a132010-08-09 20:45:32 +0000293
294 llvm::OwningPtr<llvm::NamedRegionTimer> CCTimer;
295 if (getenv("LIBCLANG_TIMING")) {
296 llvm::SmallString<128> TimerName;
297 llvm::raw_svector_ostream TimerNameOut(TimerName);
Douglas Gregor7a07fcb2010-08-09 21:00:09 +0000298 TimerNameOut << "Code completion (out-of-process) @ " << complete_filename
299 << ":" << complete_line << ":" << complete_column;
Douglas Gregordf95a132010-08-09 20:45:32 +0000300 CCTimer.reset(new llvm::NamedRegionTimer(TimerNameOut.str()));
301 }
302
Ted Kremenekab188932010-01-05 19:32:54 +0000303 // The indexer, which is mainly used to determine where diagnostics go.
304 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
305
Douglas Gregor936ea3b2010-01-28 00:56:43 +0000306 // Configure the diagnostics.
307 DiagnosticOptions DiagOpts;
Douglas Gregor28019772010-04-05 23:52:57 +0000308 llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
309 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
Douglas Gregor936ea3b2010-01-28 00:56:43 +0000310
Ted Kremenekab188932010-01-05 19:32:54 +0000311 // The set of temporary files that we've built.
312 std::vector<llvm::sys::Path> TemporaryFiles;
313
314 // Build up the arguments for invoking 'clang'.
315 std::vector<const char *> argv;
316
317 // First add the complete path to the 'clang' executable.
318 llvm::sys::Path ClangPath = CXXIdx->getClangPath();
319 argv.push_back(ClangPath.c_str());
320
Daniel Dunbar3d9c6e12010-06-30 21:40:01 +0000321 // Always use Clang C++ support.
322 argv.push_back("-ccc-clang-cxx");
323
Ted Kremenekab188932010-01-05 19:32:54 +0000324 // Add the '-fsyntax-only' argument so that we only perform a basic
325 // syntax check of the code.
326 argv.push_back("-fsyntax-only");
327
328 // Add the appropriate '-code-completion-at=file:line:column' argument
329 // to perform code completion, with an "-Xclang" preceding it.
330 std::string code_complete_at;
331 code_complete_at += complete_filename;
332 code_complete_at += ":";
333 code_complete_at += llvm::utostr(complete_line);
334 code_complete_at += ":";
335 code_complete_at += llvm::utostr(complete_column);
336 argv.push_back("-Xclang");
337 argv.push_back("-code-completion-at");
338 argv.push_back("-Xclang");
339 argv.push_back(code_complete_at.c_str());
340 argv.push_back("-Xclang");
341 argv.push_back("-no-code-completion-debug-printer");
342 argv.push_back("-Xclang");
343 argv.push_back("-code-completion-macros");
Douglas Gregord93256e2010-01-28 06:00:51 +0000344 argv.push_back("-fdiagnostics-binary");
345
Douglas Gregor4db64a42010-01-23 00:14:00 +0000346 // Remap any unsaved files to temporary files.
Ted Kremenekab188932010-01-05 19:32:54 +0000347 std::vector<std::string> RemapArgs;
Douglas Gregor4db64a42010-01-23 00:14:00 +0000348 if (RemapFiles(num_unsaved_files, unsaved_files, RemapArgs, TemporaryFiles))
349 return 0;
Ted Kremenekab188932010-01-05 19:32:54 +0000350
351 // The pointers into the elements of RemapArgs are stable because we
352 // won't be adding anything to RemapArgs after this point.
353 for (unsigned i = 0, e = RemapArgs.size(); i != e; ++i)
354 argv.push_back(RemapArgs[i].c_str());
355
356 // Add the source file name (FIXME: later, we'll want to build temporary
357 // file from the buffer, or just feed the source text via standard input).
358 if (source_filename)
359 argv.push_back(source_filename);
360
361 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
362 for (int i = 0; i < num_command_line_args; ++i)
363 if (const char *arg = command_line_args[i]) {
364 if (strcmp(arg, "-o") == 0) {
365 ++i; // Also skip the matching argument.
366 continue;
367 }
368 if (strcmp(arg, "-emit-ast") == 0 ||
369 strcmp(arg, "-c") == 0 ||
370 strcmp(arg, "-fsyntax-only") == 0) {
371 continue;
372 }
373
374 // Keep the argument.
375 argv.push_back(arg);
376 }
377
Douglas Gregor3d398aa2010-07-26 16:29:14 +0000378 if (EnableLogging) {
379 std::string Log = ClangPath.str();
380 for (unsigned I = 0, N = argv.size(); I != N; ++I) {
381 Log += ' ';
382 Log += argv[I];
383 }
384 fprintf(stderr, "libclang (Code Completion): %s\n", Log.c_str());
385 }
386
Ted Kremenekab188932010-01-05 19:32:54 +0000387 // Add the null terminator.
388 argv.push_back(NULL);
389
Douglas Gregord93256e2010-01-28 06:00:51 +0000390 // Generate a temporary name for the code-completion results file.
Benjamin Kramerc2a98162010-03-13 21:22:49 +0000391 char tmpFile[L_tmpnam];
392 char *tmpFileName = tmpnam(tmpFile);
393 llvm::sys::Path ResultsFile(tmpFileName);
Ted Kremenekab188932010-01-05 19:32:54 +0000394 TemporaryFiles.push_back(ResultsFile);
395
Douglas Gregord93256e2010-01-28 06:00:51 +0000396 // Generate a temporary name for the diagnostics file.
Benjamin Kramerc2a98162010-03-13 21:22:49 +0000397 char tmpFileResults[L_tmpnam];
398 char *tmpResultsFileName = tmpnam(tmpFileResults);
399 llvm::sys::Path DiagnosticsFile(tmpResultsFileName);
Douglas Gregord93256e2010-01-28 06:00:51 +0000400 TemporaryFiles.push_back(DiagnosticsFile);
401
Douglas Gregor3d398aa2010-07-26 16:29:14 +0000402
403
Ted Kremenekab188932010-01-05 19:32:54 +0000404 // Invoke 'clang'.
405 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
406 // on Unix or NUL (Windows).
407 std::string ErrMsg;
Douglas Gregord93256e2010-01-28 06:00:51 +0000408 const llvm::sys::Path *Redirects[] = { &DevNull, &ResultsFile,
409 &DiagnosticsFile, 0 };
Ted Kremenekab188932010-01-05 19:32:54 +0000410 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
411 /* redirects */ &Redirects[0],
412 /* secondsToWait */ 0,
413 /* memoryLimits */ 0, &ErrMsg);
414
Douglas Gregor936ea3b2010-01-28 00:56:43 +0000415 if (!ErrMsg.empty()) {
416 std::string AllArgs;
Ted Kremenekab188932010-01-05 19:32:54 +0000417 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
Douglas Gregor936ea3b2010-01-28 00:56:43 +0000418 I != E; ++I) {
419 AllArgs += ' ';
Ted Kremenekab188932010-01-05 19:32:54 +0000420 if (*I)
Douglas Gregor936ea3b2010-01-28 00:56:43 +0000421 AllArgs += *I;
Ted Kremenekab188932010-01-05 19:32:54 +0000422 }
Douglas Gregor936ea3b2010-01-28 00:56:43 +0000423
Daniel Dunbar32141c82010-02-23 20:23:45 +0000424 Diags->Report(diag::err_fe_invoking) << AllArgs << ErrMsg;
Ted Kremenekab188932010-01-05 19:32:54 +0000425 }
426
427 // Parse the resulting source file to find code-completion results.
428 using llvm::MemoryBuffer;
429 using llvm::StringRef;
Douglas Gregora88084b2010-02-18 18:08:43 +0000430 AllocatedCXCodeCompleteResults *Results = new AllocatedCXCodeCompleteResults;
431 Results->Results = 0;
432 Results->NumResults = 0;
Douglas Gregora88084b2010-02-18 18:08:43 +0000433 // FIXME: Set Results->LangOpts!
Ted Kremenekab188932010-01-05 19:32:54 +0000434 if (MemoryBuffer *F = MemoryBuffer::getFile(ResultsFile.c_str())) {
435 llvm::SmallVector<CXCompletionResult, 4> CompletionResults;
436 StringRef Buffer = F->getBuffer();
437 for (const char *Str = Buffer.data(), *StrEnd = Str + Buffer.size();
438 Str < StrEnd;) {
439 unsigned KindValue;
440 if (ReadUnsigned(Str, StrEnd, KindValue))
441 break;
442
Douglas Gregor12e13132010-05-26 22:00:08 +0000443 unsigned Priority;
444 if (ReadUnsigned(Str, StrEnd, Priority))
445 break;
446
Douglas Gregor58ddb602010-08-23 23:00:57 +0000447 unsigned Availability;
448 if (ReadUnsigned(Str, StrEnd, Availability))
449 break;
450
Douglas Gregor12e13132010-05-26 22:00:08 +0000451 CXStoredCodeCompletionString *CCStr
Douglas Gregor58ddb602010-08-23 23:00:57 +0000452 = new CXStoredCodeCompletionString(Priority,
453 (CXAvailabilityKind)Availability);
Douglas Gregor12e13132010-05-26 22:00:08 +0000454 if (!CCStr->Deserialize(Str, StrEnd)) {
455 delete CCStr;
Ted Kremenekab188932010-01-05 19:32:54 +0000456 continue;
Douglas Gregor12e13132010-05-26 22:00:08 +0000457 }
Ted Kremenekab188932010-01-05 19:32:54 +0000458
459 if (!CCStr->empty()) {
460 // Vend the code-completion result to the caller.
461 CXCompletionResult Result;
462 Result.CursorKind = (CXCursorKind)KindValue;
463 Result.CompletionString = CCStr;
464 CompletionResults.push_back(Result);
465 }
466 };
467
468 // Allocate the results.
Ted Kremenekab188932010-01-05 19:32:54 +0000469 Results->Results = new CXCompletionResult [CompletionResults.size()];
470 Results->NumResults = CompletionResults.size();
471 memcpy(Results->Results, CompletionResults.data(),
472 CompletionResults.size() * sizeof(CXCompletionResult));
Douglas Gregorb75d3df2010-08-04 17:07:00 +0000473 Results->TemporaryBuffers.push_back(F);
Ted Kremenekab188932010-01-05 19:32:54 +0000474 }
475
Douglas Gregora88084b2010-02-18 18:08:43 +0000476 LoadSerializedDiagnostics(DiagnosticsFile, num_unsaved_files, unsaved_files,
477 Results->FileMgr, Results->SourceMgr,
478 Results->Diagnostics);
479
Douglas Gregor313e26c2010-02-18 23:35:40 +0000480 // Make sure we delete temporary files when the code-completion results are
481 // destroyed.
482 Results->TemporaryFiles.swap(TemporaryFiles);
Ted Kremenekab188932010-01-05 19:32:54 +0000483
Ted Kremenekda7af322010-04-15 01:02:28 +0000484#ifdef UDP_CODE_COMPLETION_LOGGER
485#ifdef UDP_CODE_COMPLETION_LOGGER_PORT
486 const llvm::TimeRecord &EndTime = llvm::TimeRecord::getCurrentTime();
487 llvm::SmallString<256> LogResult;
488 llvm::raw_svector_ostream os(LogResult);
489
490 // Figure out the language and whether or not it uses PCH.
491 const char *lang = 0;
492 bool usesPCH = false;
493
494 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
495 I != E; ++I) {
496 if (*I == 0)
497 continue;
498 if (strcmp(*I, "-x") == 0) {
499 if (I + 1 != E) {
500 lang = *(++I);
501 continue;
502 }
503 }
504 else if (strcmp(*I, "-include") == 0) {
505 if (I+1 != E) {
506 const char *arg = *(++I);
507 llvm::SmallString<512> pchName;
508 {
509 llvm::raw_svector_ostream os(pchName);
510 os << arg << ".pth";
511 }
512 pchName.push_back('\0');
513 struct stat stat_results;
514 if (stat(pchName.data(), &stat_results) == 0)
515 usesPCH = true;
516 continue;
517 }
518 }
519 }
520
Ted Kremenek2ee297f2010-04-17 00:21:42 +0000521 os << "{ ";
522 os << "\"wall\": " << (EndTime.getWallTime() - StartTime.getWallTime());
523 os << ", \"numRes\": " << Results->NumResults;
524 os << ", \"diags\": " << Results->Diagnostics.size();
525 os << ", \"pch\": " << (usesPCH ? "true" : "false");
526 os << ", \"lang\": \"" << (lang ? lang : "<unknown>") << '"';
Ted Kremenekda7af322010-04-15 01:02:28 +0000527 const char *name = getlogin();
Ted Kremenek2ee297f2010-04-17 00:21:42 +0000528 os << ", \"user\": \"" << (name ? name : "unknown") << '"';
529 os << ", \"clangVer\": \"" << getClangFullVersion() << '"';
530 os << " }";
Ted Kremenekda7af322010-04-15 01:02:28 +0000531
532 llvm::StringRef res = os.str();
533 if (res.size() > 0) {
534 do {
535 // Setup the UDP socket.
536 struct sockaddr_in servaddr;
537 bzero(&servaddr, sizeof(servaddr));
538 servaddr.sin_family = AF_INET;
539 servaddr.sin_port = htons(UDP_CODE_COMPLETION_LOGGER_PORT);
540 if (inet_pton(AF_INET, UDP_CODE_COMPLETION_LOGGER,
541 &servaddr.sin_addr) <= 0)
542 break;
543
544 int sockfd = socket(AF_INET, SOCK_DGRAM, 0);
545 if (sockfd < 0)
546 break;
547
548 sendto(sockfd, res.data(), res.size(), 0,
549 (struct sockaddr *)&servaddr, sizeof(servaddr));
550 close(sockfd);
551 }
552 while (false);
553 }
554#endif
555#endif
Douglas Gregordf463162010-08-27 21:13:41 +0000556 clang_sortCodeCompletionResults(Results->Results, Results->NumResults);
Ted Kremenekab188932010-01-05 19:32:54 +0000557 return Results;
558}
559
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000560} // end extern "C"
561
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000562namespace {
563 class CaptureCompletionResults : public CodeCompleteConsumer {
564 AllocatedCXCodeCompleteResults &AllocatedResults;
565
566 public:
567 explicit CaptureCompletionResults(AllocatedCXCodeCompleteResults &Results)
Douglas Gregor8071e422010-08-15 06:18:01 +0000568 : CodeCompleteConsumer(true, false, true, false),
569 AllocatedResults(Results) { }
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000570
Douglas Gregore6b1bb62010-08-11 21:23:17 +0000571 virtual void ProcessCodeCompleteResults(Sema &S,
572 CodeCompletionContext Context,
John McCall0a2c5e22010-08-25 06:19:51 +0000573 CodeCompletionResult *Results,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000574 unsigned NumResults) {
575 AllocatedResults.Results = new CXCompletionResult [NumResults];
576 AllocatedResults.NumResults = NumResults;
577 for (unsigned I = 0; I != NumResults; ++I) {
578 CXStoredCodeCompletionString *StoredCompletion
Douglas Gregor58ddb602010-08-23 23:00:57 +0000579 = new CXStoredCodeCompletionString(Results[I].Priority,
580 Results[I].Availability);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000581 (void)Results[I].CreateCodeCompletionString(S, StoredCompletion);
Douglas Gregor87c08a52010-08-13 22:48:40 +0000582 AllocatedResults.Results[I].CursorKind = Results[I].CursorKind;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000583 AllocatedResults.Results[I].CompletionString = StoredCompletion;
584 }
585 }
Douglas Gregor1e5e6682010-08-26 13:48:20 +0000586
587 // FIXME: Add ProcessOverloadCandidates?
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000588 };
589}
590
591extern "C" {
Daniel Dunbarb1fd3452010-08-19 23:44:10 +0000592struct CodeCompleteAtInfo {
593 CXTranslationUnit TU;
594 const char *complete_filename;
595 unsigned complete_line;
596 unsigned complete_column;
597 struct CXUnsavedFile *unsaved_files;
598 unsigned num_unsaved_files;
599 unsigned options;
600 CXCodeCompleteResults *result;
601};
602void clang_codeCompleteAt_Impl(void *UserData) {
603 CodeCompleteAtInfo *CCAI = static_cast<CodeCompleteAtInfo*>(UserData);
604 CXTranslationUnit TU = CCAI->TU;
605 const char *complete_filename = CCAI->complete_filename;
606 unsigned complete_line = CCAI->complete_line;
607 unsigned complete_column = CCAI->complete_column;
608 struct CXUnsavedFile *unsaved_files = CCAI->unsaved_files;
609 unsigned num_unsaved_files = CCAI->num_unsaved_files;
610 unsigned options = CCAI->options;
611 CCAI->result = 0;
612
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000613#ifdef UDP_CODE_COMPLETION_LOGGER
614#ifdef UDP_CODE_COMPLETION_LOGGER_PORT
615 const llvm::TimeRecord &StartTime = llvm::TimeRecord::getCurrentTime();
616#endif
617#endif
618
619 bool EnableLogging = getenv("LIBCLANG_CODE_COMPLETION_LOGGING") != 0;
620
621 ASTUnit *AST = static_cast<ASTUnit *>(TU);
622 if (!AST)
Daniel Dunbarb1fd3452010-08-19 23:44:10 +0000623 return;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000624
625 // Perform the remapping of source files.
626 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
627 for (unsigned I = 0; I != num_unsaved_files; ++I) {
628 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
629 const llvm::MemoryBuffer *Buffer
630 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
631 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
632 Buffer));
633 }
634
635 if (EnableLogging) {
636 // FIXME: Add logging.
637 }
638
639 // Parse the resulting source file to find code-completion results.
640 AllocatedCXCodeCompleteResults *Results = new AllocatedCXCodeCompleteResults;
641 Results->Results = 0;
642 Results->NumResults = 0;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000643
644 // Create a code-completion consumer to capture the results.
645 CaptureCompletionResults Capture(*Results);
646
647 // Perform completion.
648 AST->CodeComplete(complete_filename, complete_line, complete_column,
Douglas Gregorcee235c2010-08-05 09:09:23 +0000649 RemappedFiles.data(), RemappedFiles.size(),
650 (options & CXCodeComplete_IncludeMacros),
651 (options & CXCodeComplete_IncludeCodePatterns),
652 Capture,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000653 *Results->Diag, Results->LangOpts, Results->SourceMgr,
Douglas Gregor2283d792010-08-20 00:59:43 +0000654 Results->FileMgr, Results->Diagnostics,
655 Results->TemporaryBuffers);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000656
657
658
659#ifdef UDP_CODE_COMPLETION_LOGGER
660#ifdef UDP_CODE_COMPLETION_LOGGER_PORT
661 const llvm::TimeRecord &EndTime = llvm::TimeRecord::getCurrentTime();
662 llvm::SmallString<256> LogResult;
663 llvm::raw_svector_ostream os(LogResult);
664
665 // Figure out the language and whether or not it uses PCH.
666 const char *lang = 0;
667 bool usesPCH = false;
668
669 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
670 I != E; ++I) {
671 if (*I == 0)
672 continue;
673 if (strcmp(*I, "-x") == 0) {
674 if (I + 1 != E) {
675 lang = *(++I);
676 continue;
677 }
678 }
679 else if (strcmp(*I, "-include") == 0) {
680 if (I+1 != E) {
681 const char *arg = *(++I);
682 llvm::SmallString<512> pchName;
683 {
684 llvm::raw_svector_ostream os(pchName);
685 os << arg << ".pth";
686 }
687 pchName.push_back('\0');
688 struct stat stat_results;
689 if (stat(pchName.data(), &stat_results) == 0)
690 usesPCH = true;
691 continue;
692 }
693 }
694 }
695
696 os << "{ ";
697 os << "\"wall\": " << (EndTime.getWallTime() - StartTime.getWallTime());
698 os << ", \"numRes\": " << Results->NumResults;
699 os << ", \"diags\": " << Results->Diagnostics.size();
700 os << ", \"pch\": " << (usesPCH ? "true" : "false");
701 os << ", \"lang\": \"" << (lang ? lang : "<unknown>") << '"';
702 const char *name = getlogin();
703 os << ", \"user\": \"" << (name ? name : "unknown") << '"';
704 os << ", \"clangVer\": \"" << getClangFullVersion() << '"';
705 os << " }";
706
707 llvm::StringRef res = os.str();
708 if (res.size() > 0) {
709 do {
710 // Setup the UDP socket.
711 struct sockaddr_in servaddr;
712 bzero(&servaddr, sizeof(servaddr));
713 servaddr.sin_family = AF_INET;
714 servaddr.sin_port = htons(UDP_CODE_COMPLETION_LOGGER_PORT);
715 if (inet_pton(AF_INET, UDP_CODE_COMPLETION_LOGGER,
716 &servaddr.sin_addr) <= 0)
717 break;
718
719 int sockfd = socket(AF_INET, SOCK_DGRAM, 0);
720 if (sockfd < 0)
721 break;
722
723 sendto(sockfd, res.data(), res.size(), 0,
724 (struct sockaddr *)&servaddr, sizeof(servaddr));
725 close(sockfd);
726 }
727 while (false);
728 }
729#endif
730#endif
Daniel Dunbarb1fd3452010-08-19 23:44:10 +0000731 CCAI->result = Results;
732}
733CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
734 const char *complete_filename,
735 unsigned complete_line,
736 unsigned complete_column,
737 struct CXUnsavedFile *unsaved_files,
738 unsigned num_unsaved_files,
739 unsigned options) {
740 CodeCompleteAtInfo CCAI = { TU, complete_filename, complete_line,
741 complete_column, unsaved_files, num_unsaved_files,
742 options, 0 };
743 llvm::CrashRecoveryContext CRC;
744
745 if (!CRC.RunSafely(clang_codeCompleteAt_Impl, &CCAI)) {
746 fprintf(stderr, "libclang: crash detected in code completion\n");
747 static_cast<ASTUnit *>(TU)->setUnsafeToFree(true);
748 return 0;
749 }
750
751 return CCAI.result;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000752}
753
Douglas Gregorcee235c2010-08-05 09:09:23 +0000754unsigned clang_defaultCodeCompleteOptions(void) {
755 return CXCodeComplete_IncludeMacros;
756}
757
Ted Kremenekab188932010-01-05 19:32:54 +0000758void clang_disposeCodeCompleteResults(CXCodeCompleteResults *ResultsIn) {
759 if (!ResultsIn)
760 return;
761
762 AllocatedCXCodeCompleteResults *Results
763 = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
Ted Kremenekab188932010-01-05 19:32:54 +0000764 delete Results;
765}
Douglas Gregor58ddb602010-08-23 23:00:57 +0000766
Douglas Gregora88084b2010-02-18 18:08:43 +0000767unsigned
768clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *ResultsIn) {
769 AllocatedCXCodeCompleteResults *Results
770 = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
771 if (!Results)
772 return 0;
773
774 return Results->Diagnostics.size();
775}
776
777CXDiagnostic
778clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *ResultsIn,
779 unsigned Index) {
780 AllocatedCXCodeCompleteResults *Results
781 = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
782 if (!Results || Index >= Results->Diagnostics.size())
783 return 0;
784
785 return new CXStoredDiagnostic(Results->Diagnostics[Index], Results->LangOpts);
786}
787
788
Ted Kremenekab188932010-01-05 19:32:54 +0000789} // end extern "C"
Douglas Gregor1e5e6682010-08-26 13:48:20 +0000790
791namespace {
792 struct OrderCompletionResults {
793 bool operator()(const CXCompletionResult &XR,
794 const CXCompletionResult &YR) const {
795 CXStoredCodeCompletionString *X
796 = (CXStoredCodeCompletionString *)XR.CompletionString;
797 CXStoredCodeCompletionString *Y
798 = (CXStoredCodeCompletionString *)YR.CompletionString;
799
800 const char *XText = X->getTypedText();
801 const char *YText = Y->getTypedText();
802 if (!XText || !YText)
803 return XText != 0;
804
805 int result = llvm::StringRef(XText).compare_lower(YText);
806 if (result < 0)
807 return true;
808 if (result > 0)
809 return false;
810
811 result = llvm::StringRef(XText).compare(YText);
812 return result;
813 }
814 };
815}
816
817extern "C" {
818 void clang_sortCodeCompletionResults(CXCompletionResult *Results,
819 unsigned NumResults) {
820 std::stable_sort(Results, Results + NumResults, OrderCompletionResults());
821 }
Douglas Gregor458433d2010-08-26 15:07:07 +0000822}