CIndexCodeCompletion.cpp revision e0cc52ef8afc8d1cba9c534191b5f0ddaff1d694 
1//===- 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"
16#include "CIndexDiagnostic.h"
17#include "clang/Basic/SourceManager.h"
18#include "clang/Basic/FileManager.h"
19#include "clang/Frontend/ASTUnit.h"
20#include "clang/Frontend/CompilerInstance.h"
21#include "clang/Frontend/FrontendDiagnostic.h"
22#include "clang/Sema/CodeCompleteConsumer.h"
23#include "llvm/ADT/SmallString.h"
24#include "llvm/ADT/StringExtras.h"
25#include "llvm/Support/CrashRecoveryContext.h"
26#include "llvm/Support/MemoryBuffer.h"
27#include "llvm/Support/Timer.h"
28#include "llvm/Support/raw_ostream.h"
29#include "llvm/System/Program.h"
30#include <cstdlib>
31#include <cstdio>
32
33
34#ifdef UDP_CODE_COMPLETION_LOGGER
35#include "clang/Basic/Version.h"
36#include <arpa/inet.h>
37#include <sys/socket.h>
38#include <sys/types.h>
39#include <unistd.h>
40#endif
41
42using namespace clang;
43using namespace clang::cxstring;
44
45namespace {
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;
51    CXAvailabilityKind Availability;
52
53  public:
54    CXStoredCodeCompletionString(unsigned Priority,
55                                 CXAvailabilityKind Availability)
56      : Priority(Priority), Availability(Availability) { }
57
58    unsigned getPriority() const { return Priority; }
59    CXAvailabilityKind getAvailability() const { return Availability; }
60  };
61}
62
63extern "C" {
64
65enum CXCompletionChunkKind
66clang_getCompletionChunkKind(CXCompletionString completion_string,
67                             unsigned chunk_number) {
68  CXStoredCodeCompletionString *CCStr
69    = (CXStoredCodeCompletionString *)completion_string;
70  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;
106  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;
116  }
117
118  // Should be unreachable, but let's be careful.
119  return CXCompletionChunk_Text;
120}
121
122CXString clang_getCompletionChunkText(CXCompletionString completion_string,
123                                      unsigned chunk_number) {
124  CXStoredCodeCompletionString *CCStr
125    = (CXStoredCodeCompletionString *)completion_string;
126  if (!CCStr || chunk_number >= CCStr->size())
127    return createCXString(0);
128
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:
145  case CodeCompletionString::CK_Colon:
146  case CodeCompletionString::CK_SemiColon:
147  case CodeCompletionString::CK_Equal:
148  case CodeCompletionString::CK_HorizontalSpace:
149  case CodeCompletionString::CK_VerticalSpace:
150    return createCXString((*CCStr)[chunk_number].Text, false);
151
152  case CodeCompletionString::CK_Optional:
153    // Note: treated as an empty text block.
154    return createCXString("");
155  }
156
157  // Should be unreachable, but let's be careful.
158  return createCXString(0);
159}
160
161
162CXCompletionString
163clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
164                                         unsigned chunk_number) {
165  CXStoredCodeCompletionString *CCStr
166    = (CXStoredCodeCompletionString *)completion_string;
167  if (!CCStr || chunk_number >= CCStr->size())
168    return 0;
169
170  switch ((*CCStr)[chunk_number].Kind) {
171  case CodeCompletionString::CK_TypedText:
172  case CodeCompletionString::CK_Text:
173  case CodeCompletionString::CK_Placeholder:
174  case CodeCompletionString::CK_CurrentParameter:
175  case CodeCompletionString::CK_Informative:
176  case CodeCompletionString::CK_LeftParen:
177  case CodeCompletionString::CK_RightParen:
178  case CodeCompletionString::CK_LeftBracket:
179  case CodeCompletionString::CK_RightBracket:
180  case CodeCompletionString::CK_LeftBrace:
181  case CodeCompletionString::CK_RightBrace:
182  case CodeCompletionString::CK_LeftAngle:
183  case CodeCompletionString::CK_RightAngle:
184  case CodeCompletionString::CK_Comma:
185  case CodeCompletionString::CK_ResultType:
186  case CodeCompletionString::CK_Colon:
187  case CodeCompletionString::CK_SemiColon:
188  case CodeCompletionString::CK_Equal:
189  case CodeCompletionString::CK_HorizontalSpace:
190  case CodeCompletionString::CK_VerticalSpace:
191    return 0;
192
193  case CodeCompletionString::CK_Optional:
194    // Note: treated as an empty text block.
195    return (*CCStr)[chunk_number].Optional;
196  }
197
198  // Should be unreachable, but let's be careful.
199  return 0;
200}
201
202unsigned clang_getNumCompletionChunks(CXCompletionString completion_string) {
203  CXStoredCodeCompletionString *CCStr
204    = (CXStoredCodeCompletionString *)completion_string;
205  return CCStr? CCStr->size() : 0;
206}
207
208unsigned clang_getCompletionPriority(CXCompletionString completion_string) {
209  CXStoredCodeCompletionString *CCStr
210    = (CXStoredCodeCompletionString *)completion_string;
211  return CCStr? CCStr->getPriority() : unsigned(CCP_Unlikely);
212}
213
214enum CXAvailabilityKind
215clang_getCompletionAvailability(CXCompletionString completion_string) {
216  CXStoredCodeCompletionString *CCStr
217    = (CXStoredCodeCompletionString *)completion_string;
218  return CCStr? CCStr->getAvailability() : CXAvailability_Available;
219}
220
221/// \brief The CXCodeCompleteResults structure we allocate internally;
222/// the client only sees the initial CXCodeCompleteResults structure.
223struct AllocatedCXCodeCompleteResults : public CXCodeCompleteResults {
224  AllocatedCXCodeCompleteResults();
225  ~AllocatedCXCodeCompleteResults();
226
227  /// \brief Diagnostics produced while performing code completion.
228  llvm::SmallVector<StoredDiagnostic, 8> Diagnostics;
229
230  /// \brief Diag object
231  llvm::IntrusiveRefCntPtr<Diagnostic> Diag;
232
233  /// \brief Language options used to adjust source locations.
234  LangOptions LangOpts;
235
236  /// \brief Source manager, used for diagnostics.
237  SourceManager SourceMgr;
238
239  /// \brief File manager, used for diagnostics.
240  FileManager FileMgr;
241
242  /// \brief Temporary files that should be removed once we have finished
243  /// with the code-completion results.
244  std::vector<llvm::sys::Path> TemporaryFiles;
245
246  /// \brief Temporary buffers that will be deleted once we have finished with the code-completion results.
247  llvm::SmallVector<const llvm::MemoryBuffer *, 1> TemporaryBuffers;
248};
249
250AllocatedCXCodeCompleteResults::AllocatedCXCodeCompleteResults()
251  : CXCodeCompleteResults(), Diag(new Diagnostic), SourceMgr(*Diag) { }
252
253AllocatedCXCodeCompleteResults::~AllocatedCXCodeCompleteResults() {
254  for (unsigned I = 0, N = NumResults; I != N; ++I)
255    delete (CXStoredCodeCompletionString *)Results[I].CompletionString;
256  delete [] Results;
257
258  for (unsigned I = 0, N = TemporaryFiles.size(); I != N; ++I)
259    TemporaryFiles[I].eraseFromDisk();
260  for (unsigned I = 0, N = TemporaryBuffers.size(); I != N; ++I)
261    delete TemporaryBuffers[I];
262}
263
264} // end extern "C"
265
266namespace {
267  class CaptureCompletionResults : public CodeCompleteConsumer {
268    AllocatedCXCodeCompleteResults &AllocatedResults;
269    llvm::SmallVector<CXCompletionResult, 16> StoredResults;
270
271  public:
272    explicit CaptureCompletionResults(AllocatedCXCodeCompleteResults &Results)
273      : CodeCompleteConsumer(true, false, true, false),
274        AllocatedResults(Results) { }
275    ~CaptureCompletionResults() { Finish(); }
276
277    virtual void ProcessCodeCompleteResults(Sema &S,
278                                            CodeCompletionContext Context,
279                                            CodeCompletionResult *Results,
280                                            unsigned NumResults) {
281      StoredResults.reserve(StoredResults.size() + NumResults);
282      for (unsigned I = 0; I != NumResults; ++I) {
283        CXStoredCodeCompletionString *StoredCompletion
284          = new CXStoredCodeCompletionString(Results[I].Priority,
285                                             Results[I].Availability);
286        (void)Results[I].CreateCodeCompletionString(S, StoredCompletion);
287
288        CXCompletionResult R;
289        R.CursorKind = Results[I].CursorKind;
290        R.CompletionString = StoredCompletion;
291        StoredResults.push_back(R);
292      }
293    }
294
295    virtual void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg,
296                                           OverloadCandidate *Candidates,
297                                           unsigned NumCandidates) {
298      StoredResults.reserve(StoredResults.size() + NumCandidates);
299      for (unsigned I = 0; I != NumCandidates; ++I) {
300        // FIXME: Set priority, availability appropriately.
301        CXStoredCodeCompletionString *StoredCompletion
302          = new CXStoredCodeCompletionString(1, CXAvailability_Available);
303        (void)Candidates[I].CreateSignatureString(CurrentArg, S,
304                                                  StoredCompletion);
305
306        CXCompletionResult R;
307        R.CursorKind = CXCursor_NotImplemented;
308        R.CompletionString = StoredCompletion;
309        StoredResults.push_back(R);
310      }
311    }
312
313  private:
314    void Finish() {
315      AllocatedResults.Results = new CXCompletionResult [StoredResults.size()];
316      AllocatedResults.NumResults = StoredResults.size();
317      std::memcpy(AllocatedResults.Results, StoredResults.data(),
318                  StoredResults.size() * sizeof(CXCompletionResult));
319      StoredResults.clear();
320    }
321  };
322}
323
324extern "C" {
325struct CodeCompleteAtInfo {
326  CXTranslationUnit TU;
327  const char *complete_filename;
328  unsigned complete_line;
329  unsigned complete_column;
330  struct CXUnsavedFile *unsaved_files;
331  unsigned num_unsaved_files;
332  unsigned options;
333  CXCodeCompleteResults *result;
334};
335void clang_codeCompleteAt_Impl(void *UserData) {
336  CodeCompleteAtInfo *CCAI = static_cast<CodeCompleteAtInfo*>(UserData);
337  CXTranslationUnit TU = CCAI->TU;
338  const char *complete_filename = CCAI->complete_filename;
339  unsigned complete_line = CCAI->complete_line;
340  unsigned complete_column = CCAI->complete_column;
341  struct CXUnsavedFile *unsaved_files = CCAI->unsaved_files;
342  unsigned num_unsaved_files = CCAI->num_unsaved_files;
343  unsigned options = CCAI->options;
344  CCAI->result = 0;
345
346#ifdef UDP_CODE_COMPLETION_LOGGER
347#ifdef UDP_CODE_COMPLETION_LOGGER_PORT
348  const llvm::TimeRecord &StartTime =  llvm::TimeRecord::getCurrentTime();
349#endif
350#endif
351
352  bool EnableLogging = getenv("LIBCLANG_CODE_COMPLETION_LOGGING") != 0;
353
354  ASTUnit *AST = static_cast<ASTUnit *>(TU);
355  if (!AST)
356    return;
357
358  ASTUnit::ConcurrencyCheck Check(*AST);
359
360  // Perform the remapping of source files.
361  llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
362  for (unsigned I = 0; I != num_unsaved_files; ++I) {
363    llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
364    const llvm::MemoryBuffer *Buffer
365      = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
366    RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
367                                           Buffer));
368  }
369
370  if (EnableLogging) {
371    // FIXME: Add logging.
372  }
373
374  // Parse the resulting source file to find code-completion results.
375  AllocatedCXCodeCompleteResults *Results = new AllocatedCXCodeCompleteResults;
376  Results->Results = 0;
377  Results->NumResults = 0;
378
379  // Create a code-completion consumer to capture the results.
380  CaptureCompletionResults Capture(*Results);
381
382  // Perform completion.
383  AST->CodeComplete(complete_filename, complete_line, complete_column,
384                    RemappedFiles.data(), RemappedFiles.size(),
385                    (options & CXCodeComplete_IncludeMacros),
386                    (options & CXCodeComplete_IncludeCodePatterns),
387                    Capture,
388                    *Results->Diag, Results->LangOpts, Results->SourceMgr,
389                    Results->FileMgr, Results->Diagnostics,
390                    Results->TemporaryBuffers);
391
392
393
394#ifdef UDP_CODE_COMPLETION_LOGGER
395#ifdef UDP_CODE_COMPLETION_LOGGER_PORT
396  const llvm::TimeRecord &EndTime =  llvm::TimeRecord::getCurrentTime();
397  llvm::SmallString<256> LogResult;
398  llvm::raw_svector_ostream os(LogResult);
399
400  // Figure out the language and whether or not it uses PCH.
401  const char *lang = 0;
402  bool usesPCH = false;
403
404  for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
405       I != E; ++I) {
406    if (*I == 0)
407      continue;
408    if (strcmp(*I, "-x") == 0) {
409      if (I + 1 != E) {
410        lang = *(++I);
411        continue;
412      }
413    }
414    else if (strcmp(*I, "-include") == 0) {
415      if (I+1 != E) {
416        const char *arg = *(++I);
417        llvm::SmallString<512> pchName;
418        {
419          llvm::raw_svector_ostream os(pchName);
420          os << arg << ".pth";
421        }
422        pchName.push_back('\0');
423        struct stat stat_results;
424        if (stat(pchName.data(), &stat_results) == 0)
425          usesPCH = true;
426        continue;
427      }
428    }
429  }
430
431  os << "{ ";
432  os << "\"wall\": " << (EndTime.getWallTime() - StartTime.getWallTime());
433  os << ", \"numRes\": " << Results->NumResults;
434  os << ", \"diags\": " << Results->Diagnostics.size();
435  os << ", \"pch\": " << (usesPCH ? "true" : "false");
436  os << ", \"lang\": \"" << (lang ? lang : "<unknown>") << '"';
437  const char *name = getlogin();
438  os << ", \"user\": \"" << (name ? name : "unknown") << '"';
439  os << ", \"clangVer\": \"" << getClangFullVersion() << '"';
440  os << " }";
441
442  llvm::StringRef res = os.str();
443  if (res.size() > 0) {
444    do {
445      // Setup the UDP socket.
446      struct sockaddr_in servaddr;
447      bzero(&servaddr, sizeof(servaddr));
448      servaddr.sin_family = AF_INET;
449      servaddr.sin_port = htons(UDP_CODE_COMPLETION_LOGGER_PORT);
450      if (inet_pton(AF_INET, UDP_CODE_COMPLETION_LOGGER,
451                    &servaddr.sin_addr) <= 0)
452        break;
453
454      int sockfd = socket(AF_INET, SOCK_DGRAM, 0);
455      if (sockfd < 0)
456        break;
457
458      sendto(sockfd, res.data(), res.size(), 0,
459             (struct sockaddr *)&servaddr, sizeof(servaddr));
460      close(sockfd);
461    }
462    while (false);
463  }
464#endif
465#endif
466  CCAI->result = Results;
467}
468CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
469                                            const char *complete_filename,
470                                            unsigned complete_line,
471                                            unsigned complete_column,
472                                            struct CXUnsavedFile *unsaved_files,
473                                            unsigned num_unsaved_files,
474                                            unsigned options) {
475  CodeCompleteAtInfo CCAI = { TU, complete_filename, complete_line,
476                              complete_column, unsaved_files, num_unsaved_files,
477                              options, 0 };
478  llvm::CrashRecoveryContext CRC;
479
480  if (!CRC.RunSafely(clang_codeCompleteAt_Impl, &CCAI)) {
481    fprintf(stderr, "libclang: crash detected in code completion\n");
482    static_cast<ASTUnit *>(TU)->setUnsafeToFree(true);
483    return 0;
484  }
485
486  return CCAI.result;
487}
488
489unsigned clang_defaultCodeCompleteOptions(void) {
490  return CXCodeComplete_IncludeMacros;
491}
492
493void clang_disposeCodeCompleteResults(CXCodeCompleteResults *ResultsIn) {
494  if (!ResultsIn)
495    return;
496
497  AllocatedCXCodeCompleteResults *Results
498    = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
499  delete Results;
500}
501
502unsigned
503clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *ResultsIn) {
504  AllocatedCXCodeCompleteResults *Results
505    = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
506  if (!Results)
507    return 0;
508
509  return Results->Diagnostics.size();
510}
511
512CXDiagnostic
513clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *ResultsIn,
514                                unsigned Index) {
515  AllocatedCXCodeCompleteResults *Results
516    = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
517  if (!Results || Index >= Results->Diagnostics.size())
518    return 0;
519
520  return new CXStoredDiagnostic(Results->Diagnostics[Index], Results->LangOpts);
521}
522
523
524} // end extern "C"
525
526namespace {
527  struct OrderCompletionResults {
528    bool operator()(const CXCompletionResult &XR,
529                    const CXCompletionResult &YR) const {
530      CXStoredCodeCompletionString *X
531        = (CXStoredCodeCompletionString *)XR.CompletionString;
532      CXStoredCodeCompletionString *Y
533        = (CXStoredCodeCompletionString *)YR.CompletionString;
534
535      const char *XText = X->getTypedText();
536      const char *YText = Y->getTypedText();
537      if (!XText || !YText)
538        return XText != 0;
539
540      int result = llvm::StringRef(XText).compare_lower(YText);
541      if (result < 0)
542        return true;
543      if (result > 0)
544        return false;
545
546      result = llvm::StringRef(XText).compare(YText);
547      return result < 0;
548    }
549  };
550}
551
552extern "C" {
553  void clang_sortCodeCompletionResults(CXCompletionResult *Results,
554                                       unsigned NumResults) {
555    std::stable_sort(Results, Results + NumResults, OrderCompletionResults());
556  }
557}
558