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