xref: /openbsd-src/gnu/llvm/clang/tools/libclang/CIndexCodeCompletion.cpp (revision 12c855180aad702bbcca06e0398d774beeafb155)
1e5dd7070Spatrick //===- CIndexCodeCompletion.cpp - Code Completion API hooks ---------------===//
2e5dd7070Spatrick //
3e5dd7070Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4e5dd7070Spatrick // See https://llvm.org/LICENSE.txt for license information.
5e5dd7070Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6e5dd7070Spatrick //
7e5dd7070Spatrick //===----------------------------------------------------------------------===//
8e5dd7070Spatrick //
9e5dd7070Spatrick // This file implements the Clang-C Source Indexing library hooks for
10e5dd7070Spatrick // code completion.
11e5dd7070Spatrick //
12e5dd7070Spatrick //===----------------------------------------------------------------------===//
13e5dd7070Spatrick 
14e5dd7070Spatrick #include "CIndexer.h"
15e5dd7070Spatrick #include "CIndexDiagnostic.h"
16e5dd7070Spatrick #include "CLog.h"
17e5dd7070Spatrick #include "CXCursor.h"
18e5dd7070Spatrick #include "CXSourceLocation.h"
19e5dd7070Spatrick #include "CXString.h"
20e5dd7070Spatrick #include "CXTranslationUnit.h"
21e5dd7070Spatrick #include "clang/AST/Decl.h"
22e5dd7070Spatrick #include "clang/AST/DeclObjC.h"
23e5dd7070Spatrick #include "clang/AST/Type.h"
24e5dd7070Spatrick #include "clang/Basic/FileManager.h"
25e5dd7070Spatrick #include "clang/Basic/SourceManager.h"
26e5dd7070Spatrick #include "clang/Frontend/ASTUnit.h"
27e5dd7070Spatrick #include "clang/Frontend/CompilerInstance.h"
28e5dd7070Spatrick #include "clang/Sema/CodeCompleteConsumer.h"
29e5dd7070Spatrick #include "clang/Sema/Sema.h"
30e5dd7070Spatrick #include "llvm/ADT/SmallString.h"
31e5dd7070Spatrick #include "llvm/ADT/StringExtras.h"
32e5dd7070Spatrick #include "llvm/Support/CrashRecoveryContext.h"
33e5dd7070Spatrick #include "llvm/Support/FileSystem.h"
34e5dd7070Spatrick #include "llvm/Support/FormatVariadic.h"
35e5dd7070Spatrick #include "llvm/Support/MemoryBuffer.h"
36e5dd7070Spatrick #include "llvm/Support/Program.h"
37e5dd7070Spatrick #include "llvm/Support/Timer.h"
38e5dd7070Spatrick #include "llvm/Support/raw_ostream.h"
39e5dd7070Spatrick #include <atomic>
40e5dd7070Spatrick #include <cstdio>
41e5dd7070Spatrick #include <cstdlib>
42e5dd7070Spatrick #include <string>
43e5dd7070Spatrick 
44e5dd7070Spatrick 
45e5dd7070Spatrick #ifdef UDP_CODE_COMPLETION_LOGGER
46e5dd7070Spatrick #include "clang/Basic/Version.h"
47e5dd7070Spatrick #include <arpa/inet.h>
48e5dd7070Spatrick #include <sys/socket.h>
49e5dd7070Spatrick #include <sys/types.h>
50e5dd7070Spatrick #include <unistd.h>
51e5dd7070Spatrick #endif
52e5dd7070Spatrick 
53e5dd7070Spatrick using namespace clang;
54e5dd7070Spatrick using namespace clang::cxindex;
55e5dd7070Spatrick 
56e5dd7070Spatrick enum CXCompletionChunkKind
clang_getCompletionChunkKind(CXCompletionString completion_string,unsigned chunk_number)57e5dd7070Spatrick clang_getCompletionChunkKind(CXCompletionString completion_string,
58e5dd7070Spatrick                              unsigned chunk_number) {
59e5dd7070Spatrick   CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
60e5dd7070Spatrick   if (!CCStr || chunk_number >= CCStr->size())
61e5dd7070Spatrick     return CXCompletionChunk_Text;
62e5dd7070Spatrick 
63e5dd7070Spatrick   switch ((*CCStr)[chunk_number].Kind) {
64e5dd7070Spatrick   case CodeCompletionString::CK_TypedText:
65e5dd7070Spatrick     return CXCompletionChunk_TypedText;
66e5dd7070Spatrick   case CodeCompletionString::CK_Text:
67e5dd7070Spatrick     return CXCompletionChunk_Text;
68e5dd7070Spatrick   case CodeCompletionString::CK_Optional:
69e5dd7070Spatrick     return CXCompletionChunk_Optional;
70e5dd7070Spatrick   case CodeCompletionString::CK_Placeholder:
71e5dd7070Spatrick     return CXCompletionChunk_Placeholder;
72e5dd7070Spatrick   case CodeCompletionString::CK_Informative:
73e5dd7070Spatrick     return CXCompletionChunk_Informative;
74e5dd7070Spatrick   case CodeCompletionString::CK_ResultType:
75e5dd7070Spatrick     return CXCompletionChunk_ResultType;
76e5dd7070Spatrick   case CodeCompletionString::CK_CurrentParameter:
77e5dd7070Spatrick     return CXCompletionChunk_CurrentParameter;
78e5dd7070Spatrick   case CodeCompletionString::CK_LeftParen:
79e5dd7070Spatrick     return CXCompletionChunk_LeftParen;
80e5dd7070Spatrick   case CodeCompletionString::CK_RightParen:
81e5dd7070Spatrick     return CXCompletionChunk_RightParen;
82e5dd7070Spatrick   case CodeCompletionString::CK_LeftBracket:
83e5dd7070Spatrick     return CXCompletionChunk_LeftBracket;
84e5dd7070Spatrick   case CodeCompletionString::CK_RightBracket:
85e5dd7070Spatrick     return CXCompletionChunk_RightBracket;
86e5dd7070Spatrick   case CodeCompletionString::CK_LeftBrace:
87e5dd7070Spatrick     return CXCompletionChunk_LeftBrace;
88e5dd7070Spatrick   case CodeCompletionString::CK_RightBrace:
89e5dd7070Spatrick     return CXCompletionChunk_RightBrace;
90e5dd7070Spatrick   case CodeCompletionString::CK_LeftAngle:
91e5dd7070Spatrick     return CXCompletionChunk_LeftAngle;
92e5dd7070Spatrick   case CodeCompletionString::CK_RightAngle:
93e5dd7070Spatrick     return CXCompletionChunk_RightAngle;
94e5dd7070Spatrick   case CodeCompletionString::CK_Comma:
95e5dd7070Spatrick     return CXCompletionChunk_Comma;
96e5dd7070Spatrick   case CodeCompletionString::CK_Colon:
97e5dd7070Spatrick     return CXCompletionChunk_Colon;
98e5dd7070Spatrick   case CodeCompletionString::CK_SemiColon:
99e5dd7070Spatrick     return CXCompletionChunk_SemiColon;
100e5dd7070Spatrick   case CodeCompletionString::CK_Equal:
101e5dd7070Spatrick     return CXCompletionChunk_Equal;
102e5dd7070Spatrick   case CodeCompletionString::CK_HorizontalSpace:
103e5dd7070Spatrick     return CXCompletionChunk_HorizontalSpace;
104e5dd7070Spatrick   case CodeCompletionString::CK_VerticalSpace:
105e5dd7070Spatrick     return CXCompletionChunk_VerticalSpace;
106e5dd7070Spatrick   }
107e5dd7070Spatrick 
108e5dd7070Spatrick   llvm_unreachable("Invalid CompletionKind!");
109e5dd7070Spatrick }
110e5dd7070Spatrick 
clang_getCompletionChunkText(CXCompletionString completion_string,unsigned chunk_number)111e5dd7070Spatrick CXString clang_getCompletionChunkText(CXCompletionString completion_string,
112e5dd7070Spatrick                                       unsigned chunk_number) {
113e5dd7070Spatrick   CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
114e5dd7070Spatrick   if (!CCStr || chunk_number >= CCStr->size())
115e5dd7070Spatrick     return cxstring::createNull();
116e5dd7070Spatrick 
117e5dd7070Spatrick   switch ((*CCStr)[chunk_number].Kind) {
118e5dd7070Spatrick   case CodeCompletionString::CK_TypedText:
119e5dd7070Spatrick   case CodeCompletionString::CK_Text:
120e5dd7070Spatrick   case CodeCompletionString::CK_Placeholder:
121e5dd7070Spatrick   case CodeCompletionString::CK_CurrentParameter:
122e5dd7070Spatrick   case CodeCompletionString::CK_Informative:
123e5dd7070Spatrick   case CodeCompletionString::CK_LeftParen:
124e5dd7070Spatrick   case CodeCompletionString::CK_RightParen:
125e5dd7070Spatrick   case CodeCompletionString::CK_LeftBracket:
126e5dd7070Spatrick   case CodeCompletionString::CK_RightBracket:
127e5dd7070Spatrick   case CodeCompletionString::CK_LeftBrace:
128e5dd7070Spatrick   case CodeCompletionString::CK_RightBrace:
129e5dd7070Spatrick   case CodeCompletionString::CK_LeftAngle:
130e5dd7070Spatrick   case CodeCompletionString::CK_RightAngle:
131e5dd7070Spatrick   case CodeCompletionString::CK_Comma:
132e5dd7070Spatrick   case CodeCompletionString::CK_ResultType:
133e5dd7070Spatrick   case CodeCompletionString::CK_Colon:
134e5dd7070Spatrick   case CodeCompletionString::CK_SemiColon:
135e5dd7070Spatrick   case CodeCompletionString::CK_Equal:
136e5dd7070Spatrick   case CodeCompletionString::CK_HorizontalSpace:
137e5dd7070Spatrick   case CodeCompletionString::CK_VerticalSpace:
138e5dd7070Spatrick     return cxstring::createRef((*CCStr)[chunk_number].Text);
139e5dd7070Spatrick 
140e5dd7070Spatrick   case CodeCompletionString::CK_Optional:
141e5dd7070Spatrick     // Note: treated as an empty text block.
142e5dd7070Spatrick     return cxstring::createEmpty();
143e5dd7070Spatrick   }
144e5dd7070Spatrick 
145e5dd7070Spatrick   llvm_unreachable("Invalid CodeCompletionString Kind!");
146e5dd7070Spatrick }
147e5dd7070Spatrick 
148e5dd7070Spatrick 
149e5dd7070Spatrick CXCompletionString
clang_getCompletionChunkCompletionString(CXCompletionString completion_string,unsigned chunk_number)150e5dd7070Spatrick clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
151e5dd7070Spatrick                                          unsigned chunk_number) {
152e5dd7070Spatrick   CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
153e5dd7070Spatrick   if (!CCStr || chunk_number >= CCStr->size())
154e5dd7070Spatrick     return nullptr;
155e5dd7070Spatrick 
156e5dd7070Spatrick   switch ((*CCStr)[chunk_number].Kind) {
157e5dd7070Spatrick   case CodeCompletionString::CK_TypedText:
158e5dd7070Spatrick   case CodeCompletionString::CK_Text:
159e5dd7070Spatrick   case CodeCompletionString::CK_Placeholder:
160e5dd7070Spatrick   case CodeCompletionString::CK_CurrentParameter:
161e5dd7070Spatrick   case CodeCompletionString::CK_Informative:
162e5dd7070Spatrick   case CodeCompletionString::CK_LeftParen:
163e5dd7070Spatrick   case CodeCompletionString::CK_RightParen:
164e5dd7070Spatrick   case CodeCompletionString::CK_LeftBracket:
165e5dd7070Spatrick   case CodeCompletionString::CK_RightBracket:
166e5dd7070Spatrick   case CodeCompletionString::CK_LeftBrace:
167e5dd7070Spatrick   case CodeCompletionString::CK_RightBrace:
168e5dd7070Spatrick   case CodeCompletionString::CK_LeftAngle:
169e5dd7070Spatrick   case CodeCompletionString::CK_RightAngle:
170e5dd7070Spatrick   case CodeCompletionString::CK_Comma:
171e5dd7070Spatrick   case CodeCompletionString::CK_ResultType:
172e5dd7070Spatrick   case CodeCompletionString::CK_Colon:
173e5dd7070Spatrick   case CodeCompletionString::CK_SemiColon:
174e5dd7070Spatrick   case CodeCompletionString::CK_Equal:
175e5dd7070Spatrick   case CodeCompletionString::CK_HorizontalSpace:
176e5dd7070Spatrick   case CodeCompletionString::CK_VerticalSpace:
177e5dd7070Spatrick     return nullptr;
178e5dd7070Spatrick 
179e5dd7070Spatrick   case CodeCompletionString::CK_Optional:
180e5dd7070Spatrick     // Note: treated as an empty text block.
181e5dd7070Spatrick     return (*CCStr)[chunk_number].Optional;
182e5dd7070Spatrick   }
183e5dd7070Spatrick 
184e5dd7070Spatrick   llvm_unreachable("Invalid CompletionKind!");
185e5dd7070Spatrick }
186e5dd7070Spatrick 
clang_getNumCompletionChunks(CXCompletionString completion_string)187e5dd7070Spatrick unsigned clang_getNumCompletionChunks(CXCompletionString completion_string) {
188e5dd7070Spatrick   CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
189e5dd7070Spatrick   return CCStr? CCStr->size() : 0;
190e5dd7070Spatrick }
191e5dd7070Spatrick 
clang_getCompletionPriority(CXCompletionString completion_string)192e5dd7070Spatrick unsigned clang_getCompletionPriority(CXCompletionString completion_string) {
193e5dd7070Spatrick   CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
194e5dd7070Spatrick   return CCStr? CCStr->getPriority() : unsigned(CCP_Unlikely);
195e5dd7070Spatrick }
196e5dd7070Spatrick 
197e5dd7070Spatrick enum CXAvailabilityKind
clang_getCompletionAvailability(CXCompletionString completion_string)198e5dd7070Spatrick clang_getCompletionAvailability(CXCompletionString completion_string) {
199e5dd7070Spatrick   CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
200e5dd7070Spatrick   return CCStr? static_cast<CXAvailabilityKind>(CCStr->getAvailability())
201e5dd7070Spatrick               : CXAvailability_Available;
202e5dd7070Spatrick }
203e5dd7070Spatrick 
clang_getCompletionNumAnnotations(CXCompletionString completion_string)204e5dd7070Spatrick unsigned clang_getCompletionNumAnnotations(CXCompletionString completion_string)
205e5dd7070Spatrick {
206e5dd7070Spatrick   CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
207e5dd7070Spatrick   return CCStr ? CCStr->getAnnotationCount() : 0;
208e5dd7070Spatrick }
209e5dd7070Spatrick 
clang_getCompletionAnnotation(CXCompletionString completion_string,unsigned annotation_number)210e5dd7070Spatrick CXString clang_getCompletionAnnotation(CXCompletionString completion_string,
211e5dd7070Spatrick                                        unsigned annotation_number) {
212e5dd7070Spatrick   CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
213e5dd7070Spatrick   return CCStr ? cxstring::createRef(CCStr->getAnnotation(annotation_number))
214e5dd7070Spatrick                : cxstring::createNull();
215e5dd7070Spatrick }
216e5dd7070Spatrick 
217e5dd7070Spatrick CXString
clang_getCompletionParent(CXCompletionString completion_string,CXCursorKind * kind)218e5dd7070Spatrick clang_getCompletionParent(CXCompletionString completion_string,
219e5dd7070Spatrick                           CXCursorKind *kind) {
220e5dd7070Spatrick   if (kind)
221e5dd7070Spatrick     *kind = CXCursor_NotImplemented;
222e5dd7070Spatrick 
223e5dd7070Spatrick   CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
224e5dd7070Spatrick   if (!CCStr)
225e5dd7070Spatrick     return cxstring::createNull();
226e5dd7070Spatrick 
227e5dd7070Spatrick   return cxstring::createRef(CCStr->getParentContextName());
228e5dd7070Spatrick }
229e5dd7070Spatrick 
230e5dd7070Spatrick CXString
clang_getCompletionBriefComment(CXCompletionString completion_string)231e5dd7070Spatrick clang_getCompletionBriefComment(CXCompletionString completion_string) {
232e5dd7070Spatrick   CodeCompletionString *CCStr = (CodeCompletionString *)completion_string;
233e5dd7070Spatrick 
234e5dd7070Spatrick   if (!CCStr)
235e5dd7070Spatrick     return cxstring::createNull();
236e5dd7070Spatrick 
237e5dd7070Spatrick   return cxstring::createRef(CCStr->getBriefComment());
238e5dd7070Spatrick }
239e5dd7070Spatrick 
240e5dd7070Spatrick namespace {
241e5dd7070Spatrick 
242e5dd7070Spatrick /// The CXCodeCompleteResults structure we allocate internally;
243e5dd7070Spatrick /// the client only sees the initial CXCodeCompleteResults structure.
244e5dd7070Spatrick ///
245e5dd7070Spatrick /// Normally, clients of CXString shouldn't care whether or not a CXString is
246e5dd7070Spatrick /// managed by a pool or by explicitly malloc'ed memory.  But
247e5dd7070Spatrick /// AllocatedCXCodeCompleteResults outlives the CXTranslationUnit, so we can
248e5dd7070Spatrick /// not rely on the StringPool in the TU.
249e5dd7070Spatrick struct AllocatedCXCodeCompleteResults : public CXCodeCompleteResults {
250e5dd7070Spatrick   AllocatedCXCodeCompleteResults(IntrusiveRefCntPtr<FileManager> FileMgr);
251e5dd7070Spatrick   ~AllocatedCXCodeCompleteResults();
252e5dd7070Spatrick 
253e5dd7070Spatrick   /// Diagnostics produced while performing code completion.
254e5dd7070Spatrick   SmallVector<StoredDiagnostic, 8> Diagnostics;
255e5dd7070Spatrick 
256e5dd7070Spatrick   /// Allocated API-exposed wrappters for Diagnostics.
257ec727ea7Spatrick   SmallVector<std::unique_ptr<CXStoredDiagnostic>, 8> DiagnosticsWrappers;
258e5dd7070Spatrick 
259e5dd7070Spatrick   IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts;
260e5dd7070Spatrick 
261e5dd7070Spatrick   /// Diag object
262e5dd7070Spatrick   IntrusiveRefCntPtr<DiagnosticsEngine> Diag;
263e5dd7070Spatrick 
264e5dd7070Spatrick   /// Language options used to adjust source locations.
265e5dd7070Spatrick   LangOptions LangOpts;
266e5dd7070Spatrick 
267e5dd7070Spatrick   /// File manager, used for diagnostics.
268e5dd7070Spatrick   IntrusiveRefCntPtr<FileManager> FileMgr;
269e5dd7070Spatrick 
270e5dd7070Spatrick   /// Source manager, used for diagnostics.
271e5dd7070Spatrick   IntrusiveRefCntPtr<SourceManager> SourceMgr;
272e5dd7070Spatrick 
273e5dd7070Spatrick   /// Temporary buffers that will be deleted once we have finished with
274e5dd7070Spatrick   /// the code-completion results.
275e5dd7070Spatrick   SmallVector<const llvm::MemoryBuffer *, 1> TemporaryBuffers;
276e5dd7070Spatrick 
277e5dd7070Spatrick   /// Allocator used to store globally cached code-completion results.
278e5dd7070Spatrick   std::shared_ptr<clang::GlobalCodeCompletionAllocator>
279e5dd7070Spatrick       CachedCompletionAllocator;
280e5dd7070Spatrick 
281e5dd7070Spatrick   /// Allocator used to store code completion results.
282e5dd7070Spatrick   std::shared_ptr<clang::GlobalCodeCompletionAllocator> CodeCompletionAllocator;
283e5dd7070Spatrick 
284e5dd7070Spatrick   /// Context under which completion occurred.
285e5dd7070Spatrick   enum clang::CodeCompletionContext::Kind ContextKind;
286e5dd7070Spatrick 
287e5dd7070Spatrick   /// A bitfield representing the acceptable completions for the
288e5dd7070Spatrick   /// current context.
289e5dd7070Spatrick   unsigned long long Contexts;
290e5dd7070Spatrick 
291e5dd7070Spatrick   /// The kind of the container for the current context for completions.
292e5dd7070Spatrick   enum CXCursorKind ContainerKind;
293e5dd7070Spatrick 
294e5dd7070Spatrick   /// The USR of the container for the current context for completions.
295e5dd7070Spatrick   std::string ContainerUSR;
296e5dd7070Spatrick 
297e5dd7070Spatrick   /// a boolean value indicating whether there is complete information
298e5dd7070Spatrick   /// about the container
299e5dd7070Spatrick   unsigned ContainerIsIncomplete;
300e5dd7070Spatrick 
301e5dd7070Spatrick   /// A string containing the Objective-C selector entered thus far for a
302e5dd7070Spatrick   /// message send.
303e5dd7070Spatrick   std::string Selector;
304e5dd7070Spatrick 
305e5dd7070Spatrick   /// Vector of fix-its for each completion result that *must* be applied
306e5dd7070Spatrick   /// before that result for the corresponding completion item.
307e5dd7070Spatrick   std::vector<std::vector<FixItHint>> FixItsVector;
308e5dd7070Spatrick };
309e5dd7070Spatrick 
310e5dd7070Spatrick } // end anonymous namespace
311e5dd7070Spatrick 
clang_getCompletionNumFixIts(CXCodeCompleteResults * results,unsigned completion_index)312e5dd7070Spatrick unsigned clang_getCompletionNumFixIts(CXCodeCompleteResults *results,
313e5dd7070Spatrick                                       unsigned completion_index) {
314e5dd7070Spatrick   AllocatedCXCodeCompleteResults *allocated_results = (AllocatedCXCodeCompleteResults *)results;
315e5dd7070Spatrick 
316e5dd7070Spatrick   if (!allocated_results || allocated_results->FixItsVector.size() <= completion_index)
317e5dd7070Spatrick     return 0;
318e5dd7070Spatrick 
319e5dd7070Spatrick   return static_cast<unsigned>(allocated_results->FixItsVector[completion_index].size());
320e5dd7070Spatrick }
321e5dd7070Spatrick 
clang_getCompletionFixIt(CXCodeCompleteResults * results,unsigned completion_index,unsigned fixit_index,CXSourceRange * replacement_range)322e5dd7070Spatrick CXString clang_getCompletionFixIt(CXCodeCompleteResults *results,
323e5dd7070Spatrick                                   unsigned completion_index,
324e5dd7070Spatrick                                   unsigned fixit_index,
325e5dd7070Spatrick                                   CXSourceRange *replacement_range) {
326e5dd7070Spatrick   AllocatedCXCodeCompleteResults *allocated_results = (AllocatedCXCodeCompleteResults *)results;
327e5dd7070Spatrick 
328e5dd7070Spatrick   if (!allocated_results || allocated_results->FixItsVector.size() <= completion_index) {
329e5dd7070Spatrick     if (replacement_range)
330e5dd7070Spatrick       *replacement_range = clang_getNullRange();
331e5dd7070Spatrick     return cxstring::createNull();
332e5dd7070Spatrick   }
333e5dd7070Spatrick 
334e5dd7070Spatrick   ArrayRef<FixItHint> FixIts = allocated_results->FixItsVector[completion_index];
335e5dd7070Spatrick   if (FixIts.size() <= fixit_index) {
336e5dd7070Spatrick     if (replacement_range)
337e5dd7070Spatrick       *replacement_range = clang_getNullRange();
338e5dd7070Spatrick     return cxstring::createNull();
339e5dd7070Spatrick   }
340e5dd7070Spatrick 
341e5dd7070Spatrick   const FixItHint &FixIt = FixIts[fixit_index];
342e5dd7070Spatrick   if (replacement_range) {
343e5dd7070Spatrick     *replacement_range = cxloc::translateSourceRange(
344e5dd7070Spatrick         *allocated_results->SourceMgr, allocated_results->LangOpts,
345e5dd7070Spatrick         FixIt.RemoveRange);
346e5dd7070Spatrick   }
347e5dd7070Spatrick 
348e5dd7070Spatrick   return cxstring::createRef(FixIt.CodeToInsert.c_str());
349e5dd7070Spatrick }
350e5dd7070Spatrick 
351e5dd7070Spatrick /// Tracks the number of code-completion result objects that are
352e5dd7070Spatrick /// currently active.
353e5dd7070Spatrick ///
354e5dd7070Spatrick /// Used for debugging purposes only.
355e5dd7070Spatrick static std::atomic<unsigned> CodeCompletionResultObjects;
356e5dd7070Spatrick 
AllocatedCXCodeCompleteResults(IntrusiveRefCntPtr<FileManager> FileMgr)357e5dd7070Spatrick AllocatedCXCodeCompleteResults::AllocatedCXCodeCompleteResults(
358e5dd7070Spatrick     IntrusiveRefCntPtr<FileManager> FileMgr)
359e5dd7070Spatrick     : CXCodeCompleteResults(), DiagOpts(new DiagnosticOptions),
360e5dd7070Spatrick       Diag(new DiagnosticsEngine(
361e5dd7070Spatrick           IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs), &*DiagOpts)),
362e5dd7070Spatrick       FileMgr(std::move(FileMgr)),
363e5dd7070Spatrick       SourceMgr(new SourceManager(*Diag, *this->FileMgr)),
364e5dd7070Spatrick       CodeCompletionAllocator(
365e5dd7070Spatrick           std::make_shared<clang::GlobalCodeCompletionAllocator>()),
366e5dd7070Spatrick       Contexts(CXCompletionContext_Unknown),
367e5dd7070Spatrick       ContainerKind(CXCursor_InvalidCode), ContainerIsIncomplete(1) {
368e5dd7070Spatrick   if (getenv("LIBCLANG_OBJTRACKING"))
369e5dd7070Spatrick     fprintf(stderr, "+++ %u completion results\n",
370e5dd7070Spatrick             ++CodeCompletionResultObjects);
371e5dd7070Spatrick }
372e5dd7070Spatrick 
~AllocatedCXCodeCompleteResults()373e5dd7070Spatrick AllocatedCXCodeCompleteResults::~AllocatedCXCodeCompleteResults() {
374e5dd7070Spatrick   delete [] Results;
375e5dd7070Spatrick 
376e5dd7070Spatrick   for (unsigned I = 0, N = TemporaryBuffers.size(); I != N; ++I)
377e5dd7070Spatrick     delete TemporaryBuffers[I];
378e5dd7070Spatrick 
379e5dd7070Spatrick   if (getenv("LIBCLANG_OBJTRACKING"))
380e5dd7070Spatrick     fprintf(stderr, "--- %u completion results\n",
381e5dd7070Spatrick             --CodeCompletionResultObjects);
382e5dd7070Spatrick }
383e5dd7070Spatrick 
getContextsForContextKind(enum CodeCompletionContext::Kind kind,Sema & S)384e5dd7070Spatrick static unsigned long long getContextsForContextKind(
385e5dd7070Spatrick                                           enum CodeCompletionContext::Kind kind,
386e5dd7070Spatrick                                                     Sema &S) {
387e5dd7070Spatrick   unsigned long long contexts = 0;
388e5dd7070Spatrick   switch (kind) {
389e5dd7070Spatrick     case CodeCompletionContext::CCC_OtherWithMacros: {
390e5dd7070Spatrick       //We can allow macros here, but we don't know what else is permissible
391e5dd7070Spatrick       //So we'll say the only thing permissible are macros
392e5dd7070Spatrick       contexts = CXCompletionContext_MacroName;
393e5dd7070Spatrick       break;
394e5dd7070Spatrick     }
395e5dd7070Spatrick     case CodeCompletionContext::CCC_TopLevel:
396e5dd7070Spatrick     case CodeCompletionContext::CCC_ObjCIvarList:
397e5dd7070Spatrick     case CodeCompletionContext::CCC_ClassStructUnion:
398e5dd7070Spatrick     case CodeCompletionContext::CCC_Type: {
399e5dd7070Spatrick       contexts = CXCompletionContext_AnyType |
400e5dd7070Spatrick                  CXCompletionContext_ObjCInterface;
401e5dd7070Spatrick       if (S.getLangOpts().CPlusPlus) {
402e5dd7070Spatrick         contexts |= CXCompletionContext_EnumTag |
403e5dd7070Spatrick                     CXCompletionContext_UnionTag |
404e5dd7070Spatrick                     CXCompletionContext_StructTag |
405e5dd7070Spatrick                     CXCompletionContext_ClassTag |
406e5dd7070Spatrick                     CXCompletionContext_NestedNameSpecifier;
407e5dd7070Spatrick       }
408e5dd7070Spatrick       break;
409e5dd7070Spatrick     }
410e5dd7070Spatrick     case CodeCompletionContext::CCC_Statement: {
411e5dd7070Spatrick       contexts = CXCompletionContext_AnyType |
412e5dd7070Spatrick                  CXCompletionContext_ObjCInterface |
413e5dd7070Spatrick                  CXCompletionContext_AnyValue;
414e5dd7070Spatrick       if (S.getLangOpts().CPlusPlus) {
415e5dd7070Spatrick         contexts |= CXCompletionContext_EnumTag |
416e5dd7070Spatrick                     CXCompletionContext_UnionTag |
417e5dd7070Spatrick                     CXCompletionContext_StructTag |
418e5dd7070Spatrick                     CXCompletionContext_ClassTag |
419e5dd7070Spatrick                     CXCompletionContext_NestedNameSpecifier;
420e5dd7070Spatrick       }
421e5dd7070Spatrick       break;
422e5dd7070Spatrick     }
423e5dd7070Spatrick     case CodeCompletionContext::CCC_Expression: {
424e5dd7070Spatrick       contexts = CXCompletionContext_AnyValue;
425e5dd7070Spatrick       if (S.getLangOpts().CPlusPlus) {
426e5dd7070Spatrick         contexts |= CXCompletionContext_AnyType |
427e5dd7070Spatrick                     CXCompletionContext_ObjCInterface |
428e5dd7070Spatrick                     CXCompletionContext_EnumTag |
429e5dd7070Spatrick                     CXCompletionContext_UnionTag |
430e5dd7070Spatrick                     CXCompletionContext_StructTag |
431e5dd7070Spatrick                     CXCompletionContext_ClassTag |
432e5dd7070Spatrick                     CXCompletionContext_NestedNameSpecifier;
433e5dd7070Spatrick       }
434e5dd7070Spatrick       break;
435e5dd7070Spatrick     }
436e5dd7070Spatrick     case CodeCompletionContext::CCC_ObjCMessageReceiver: {
437e5dd7070Spatrick       contexts = CXCompletionContext_ObjCObjectValue |
438e5dd7070Spatrick                  CXCompletionContext_ObjCSelectorValue |
439e5dd7070Spatrick                  CXCompletionContext_ObjCInterface;
440e5dd7070Spatrick       if (S.getLangOpts().CPlusPlus) {
441e5dd7070Spatrick         contexts |= CXCompletionContext_CXXClassTypeValue |
442e5dd7070Spatrick                     CXCompletionContext_AnyType |
443e5dd7070Spatrick                     CXCompletionContext_EnumTag |
444e5dd7070Spatrick                     CXCompletionContext_UnionTag |
445e5dd7070Spatrick                     CXCompletionContext_StructTag |
446e5dd7070Spatrick                     CXCompletionContext_ClassTag |
447e5dd7070Spatrick                     CXCompletionContext_NestedNameSpecifier;
448e5dd7070Spatrick       }
449e5dd7070Spatrick       break;
450e5dd7070Spatrick     }
451e5dd7070Spatrick     case CodeCompletionContext::CCC_DotMemberAccess: {
452e5dd7070Spatrick       contexts = CXCompletionContext_DotMemberAccess;
453e5dd7070Spatrick       break;
454e5dd7070Spatrick     }
455e5dd7070Spatrick     case CodeCompletionContext::CCC_ArrowMemberAccess: {
456e5dd7070Spatrick       contexts = CXCompletionContext_ArrowMemberAccess;
457e5dd7070Spatrick       break;
458e5dd7070Spatrick     }
459e5dd7070Spatrick     case CodeCompletionContext::CCC_ObjCPropertyAccess: {
460e5dd7070Spatrick       contexts = CXCompletionContext_ObjCPropertyAccess;
461e5dd7070Spatrick       break;
462e5dd7070Spatrick     }
463e5dd7070Spatrick     case CodeCompletionContext::CCC_EnumTag: {
464e5dd7070Spatrick       contexts = CXCompletionContext_EnumTag |
465e5dd7070Spatrick                  CXCompletionContext_NestedNameSpecifier;
466e5dd7070Spatrick       break;
467e5dd7070Spatrick     }
468e5dd7070Spatrick     case CodeCompletionContext::CCC_UnionTag: {
469e5dd7070Spatrick       contexts = CXCompletionContext_UnionTag |
470e5dd7070Spatrick                  CXCompletionContext_NestedNameSpecifier;
471e5dd7070Spatrick       break;
472e5dd7070Spatrick     }
473e5dd7070Spatrick     case CodeCompletionContext::CCC_ClassOrStructTag: {
474e5dd7070Spatrick       contexts = CXCompletionContext_StructTag |
475e5dd7070Spatrick                  CXCompletionContext_ClassTag |
476e5dd7070Spatrick                  CXCompletionContext_NestedNameSpecifier;
477e5dd7070Spatrick       break;
478e5dd7070Spatrick     }
479e5dd7070Spatrick     case CodeCompletionContext::CCC_ObjCProtocolName: {
480e5dd7070Spatrick       contexts = CXCompletionContext_ObjCProtocol;
481e5dd7070Spatrick       break;
482e5dd7070Spatrick     }
483e5dd7070Spatrick     case CodeCompletionContext::CCC_Namespace: {
484e5dd7070Spatrick       contexts = CXCompletionContext_Namespace;
485e5dd7070Spatrick       break;
486e5dd7070Spatrick     }
487e5dd7070Spatrick     case CodeCompletionContext::CCC_SymbolOrNewName:
488e5dd7070Spatrick     case CodeCompletionContext::CCC_Symbol: {
489e5dd7070Spatrick       contexts = CXCompletionContext_NestedNameSpecifier;
490e5dd7070Spatrick       break;
491e5dd7070Spatrick     }
492e5dd7070Spatrick     case CodeCompletionContext::CCC_MacroNameUse: {
493e5dd7070Spatrick       contexts = CXCompletionContext_MacroName;
494e5dd7070Spatrick       break;
495e5dd7070Spatrick     }
496e5dd7070Spatrick     case CodeCompletionContext::CCC_NaturalLanguage: {
497e5dd7070Spatrick       contexts = CXCompletionContext_NaturalLanguage;
498e5dd7070Spatrick       break;
499e5dd7070Spatrick     }
500e5dd7070Spatrick     case CodeCompletionContext::CCC_IncludedFile: {
501e5dd7070Spatrick       contexts = CXCompletionContext_IncludedFile;
502e5dd7070Spatrick       break;
503e5dd7070Spatrick     }
504e5dd7070Spatrick     case CodeCompletionContext::CCC_SelectorName: {
505e5dd7070Spatrick       contexts = CXCompletionContext_ObjCSelectorName;
506e5dd7070Spatrick       break;
507e5dd7070Spatrick     }
508e5dd7070Spatrick     case CodeCompletionContext::CCC_ParenthesizedExpression: {
509e5dd7070Spatrick       contexts = CXCompletionContext_AnyType |
510e5dd7070Spatrick                  CXCompletionContext_ObjCInterface |
511e5dd7070Spatrick                  CXCompletionContext_AnyValue;
512e5dd7070Spatrick       if (S.getLangOpts().CPlusPlus) {
513e5dd7070Spatrick         contexts |= CXCompletionContext_EnumTag |
514e5dd7070Spatrick                     CXCompletionContext_UnionTag |
515e5dd7070Spatrick                     CXCompletionContext_StructTag |
516e5dd7070Spatrick                     CXCompletionContext_ClassTag |
517e5dd7070Spatrick                     CXCompletionContext_NestedNameSpecifier;
518e5dd7070Spatrick       }
519e5dd7070Spatrick       break;
520e5dd7070Spatrick     }
521e5dd7070Spatrick     case CodeCompletionContext::CCC_ObjCInstanceMessage: {
522e5dd7070Spatrick       contexts = CXCompletionContext_ObjCInstanceMessage;
523e5dd7070Spatrick       break;
524e5dd7070Spatrick     }
525e5dd7070Spatrick     case CodeCompletionContext::CCC_ObjCClassMessage: {
526e5dd7070Spatrick       contexts = CXCompletionContext_ObjCClassMessage;
527e5dd7070Spatrick       break;
528e5dd7070Spatrick     }
529e5dd7070Spatrick     case CodeCompletionContext::CCC_ObjCInterfaceName: {
530e5dd7070Spatrick       contexts = CXCompletionContext_ObjCInterface;
531e5dd7070Spatrick       break;
532e5dd7070Spatrick     }
533e5dd7070Spatrick     case CodeCompletionContext::CCC_ObjCCategoryName: {
534e5dd7070Spatrick       contexts = CXCompletionContext_ObjCCategory;
535e5dd7070Spatrick       break;
536e5dd7070Spatrick     }
537e5dd7070Spatrick     case CodeCompletionContext::CCC_Other:
538e5dd7070Spatrick     case CodeCompletionContext::CCC_ObjCInterface:
539e5dd7070Spatrick     case CodeCompletionContext::CCC_ObjCImplementation:
540e5dd7070Spatrick     case CodeCompletionContext::CCC_NewName:
541e5dd7070Spatrick     case CodeCompletionContext::CCC_MacroName:
542e5dd7070Spatrick     case CodeCompletionContext::CCC_PreprocessorExpression:
543e5dd7070Spatrick     case CodeCompletionContext::CCC_PreprocessorDirective:
544*12c85518Srobert     case CodeCompletionContext::CCC_Attribute:
545e5dd7070Spatrick     case CodeCompletionContext::CCC_TypeQualifiers: {
546e5dd7070Spatrick       //Only Clang results should be accepted, so we'll set all of the other
547e5dd7070Spatrick       //context bits to 0 (i.e. the empty set)
548e5dd7070Spatrick       contexts = CXCompletionContext_Unexposed;
549e5dd7070Spatrick       break;
550e5dd7070Spatrick     }
551e5dd7070Spatrick     case CodeCompletionContext::CCC_Recovery: {
552e5dd7070Spatrick       //We don't know what the current context is, so we'll return unknown
553e5dd7070Spatrick       //This is the equivalent of setting all of the other context bits
554e5dd7070Spatrick       contexts = CXCompletionContext_Unknown;
555e5dd7070Spatrick       break;
556e5dd7070Spatrick     }
557e5dd7070Spatrick   }
558e5dd7070Spatrick   return contexts;
559e5dd7070Spatrick }
560e5dd7070Spatrick 
561e5dd7070Spatrick namespace {
562e5dd7070Spatrick   class CaptureCompletionResults : public CodeCompleteConsumer {
563e5dd7070Spatrick     AllocatedCXCodeCompleteResults &AllocatedResults;
564e5dd7070Spatrick     CodeCompletionTUInfo CCTUInfo;
565e5dd7070Spatrick     SmallVector<CXCompletionResult, 16> StoredResults;
566e5dd7070Spatrick     CXTranslationUnit *TU;
567e5dd7070Spatrick   public:
CaptureCompletionResults(const CodeCompleteOptions & Opts,AllocatedCXCodeCompleteResults & Results,CXTranslationUnit * TranslationUnit)568e5dd7070Spatrick     CaptureCompletionResults(const CodeCompleteOptions &Opts,
569e5dd7070Spatrick                              AllocatedCXCodeCompleteResults &Results,
570e5dd7070Spatrick                              CXTranslationUnit *TranslationUnit)
571e5dd7070Spatrick         : CodeCompleteConsumer(Opts), AllocatedResults(Results),
572e5dd7070Spatrick           CCTUInfo(Results.CodeCompletionAllocator), TU(TranslationUnit) {}
~CaptureCompletionResults()573e5dd7070Spatrick     ~CaptureCompletionResults() override { Finish(); }
574e5dd7070Spatrick 
ProcessCodeCompleteResults(Sema & S,CodeCompletionContext Context,CodeCompletionResult * Results,unsigned NumResults)575e5dd7070Spatrick     void ProcessCodeCompleteResults(Sema &S,
576e5dd7070Spatrick                                     CodeCompletionContext Context,
577e5dd7070Spatrick                                     CodeCompletionResult *Results,
578e5dd7070Spatrick                                     unsigned NumResults) override {
579e5dd7070Spatrick       StoredResults.reserve(StoredResults.size() + NumResults);
580e5dd7070Spatrick       if (includeFixIts())
581e5dd7070Spatrick         AllocatedResults.FixItsVector.reserve(NumResults);
582e5dd7070Spatrick       for (unsigned I = 0; I != NumResults; ++I) {
583e5dd7070Spatrick         CodeCompletionString *StoredCompletion
584e5dd7070Spatrick           = Results[I].CreateCodeCompletionString(S, Context, getAllocator(),
585e5dd7070Spatrick                                                   getCodeCompletionTUInfo(),
586e5dd7070Spatrick                                                   includeBriefComments());
587e5dd7070Spatrick 
588e5dd7070Spatrick         CXCompletionResult R;
589e5dd7070Spatrick         R.CursorKind = Results[I].CursorKind;
590e5dd7070Spatrick         R.CompletionString = StoredCompletion;
591e5dd7070Spatrick         StoredResults.push_back(R);
592e5dd7070Spatrick         if (includeFixIts())
593e5dd7070Spatrick           AllocatedResults.FixItsVector.emplace_back(std::move(Results[I].FixIts));
594e5dd7070Spatrick       }
595e5dd7070Spatrick 
596e5dd7070Spatrick       enum CodeCompletionContext::Kind contextKind = Context.getKind();
597e5dd7070Spatrick 
598e5dd7070Spatrick       AllocatedResults.ContextKind = contextKind;
599e5dd7070Spatrick       AllocatedResults.Contexts = getContextsForContextKind(contextKind, S);
600e5dd7070Spatrick 
601e5dd7070Spatrick       AllocatedResults.Selector = "";
602e5dd7070Spatrick       ArrayRef<IdentifierInfo *> SelIdents = Context.getSelIdents();
603e5dd7070Spatrick       for (ArrayRef<IdentifierInfo *>::iterator I = SelIdents.begin(),
604e5dd7070Spatrick                                                 E = SelIdents.end();
605e5dd7070Spatrick            I != E; ++I) {
606e5dd7070Spatrick         if (IdentifierInfo *selIdent = *I)
607e5dd7070Spatrick           AllocatedResults.Selector += selIdent->getName();
608e5dd7070Spatrick         AllocatedResults.Selector += ":";
609e5dd7070Spatrick       }
610e5dd7070Spatrick 
611e5dd7070Spatrick       QualType baseType = Context.getBaseType();
612e5dd7070Spatrick       NamedDecl *D = nullptr;
613e5dd7070Spatrick 
614e5dd7070Spatrick       if (!baseType.isNull()) {
615e5dd7070Spatrick         // Get the declaration for a class/struct/union/enum type
616e5dd7070Spatrick         if (const TagType *Tag = baseType->getAs<TagType>())
617e5dd7070Spatrick           D = Tag->getDecl();
618e5dd7070Spatrick         // Get the @interface declaration for a (possibly-qualified) Objective-C
619e5dd7070Spatrick         // object pointer type, e.g., NSString*
620e5dd7070Spatrick         else if (const ObjCObjectPointerType *ObjPtr =
621e5dd7070Spatrick                  baseType->getAs<ObjCObjectPointerType>())
622e5dd7070Spatrick           D = ObjPtr->getInterfaceDecl();
623e5dd7070Spatrick         // Get the @interface declaration for an Objective-C object type
624e5dd7070Spatrick         else if (const ObjCObjectType *Obj = baseType->getAs<ObjCObjectType>())
625e5dd7070Spatrick           D = Obj->getInterface();
626e5dd7070Spatrick         // Get the class for a C++ injected-class-name
627e5dd7070Spatrick         else if (const InjectedClassNameType *Injected =
628e5dd7070Spatrick                  baseType->getAs<InjectedClassNameType>())
629e5dd7070Spatrick           D = Injected->getDecl();
630e5dd7070Spatrick       }
631e5dd7070Spatrick 
632e5dd7070Spatrick       if (D != nullptr) {
633e5dd7070Spatrick         CXCursor cursor = cxcursor::MakeCXCursor(D, *TU);
634e5dd7070Spatrick 
635e5dd7070Spatrick         AllocatedResults.ContainerKind = clang_getCursorKind(cursor);
636e5dd7070Spatrick 
637e5dd7070Spatrick         CXString CursorUSR = clang_getCursorUSR(cursor);
638e5dd7070Spatrick         AllocatedResults.ContainerUSR = clang_getCString(CursorUSR);
639e5dd7070Spatrick         clang_disposeString(CursorUSR);
640e5dd7070Spatrick 
641e5dd7070Spatrick         const Type *type = baseType.getTypePtrOrNull();
642e5dd7070Spatrick         if (type) {
643e5dd7070Spatrick           AllocatedResults.ContainerIsIncomplete = type->isIncompleteType();
644e5dd7070Spatrick         }
645e5dd7070Spatrick         else {
646e5dd7070Spatrick           AllocatedResults.ContainerIsIncomplete = 1;
647e5dd7070Spatrick         }
648e5dd7070Spatrick       }
649e5dd7070Spatrick       else {
650e5dd7070Spatrick         AllocatedResults.ContainerKind = CXCursor_InvalidCode;
651e5dd7070Spatrick         AllocatedResults.ContainerUSR.clear();
652e5dd7070Spatrick         AllocatedResults.ContainerIsIncomplete = 1;
653e5dd7070Spatrick       }
654e5dd7070Spatrick     }
655e5dd7070Spatrick 
ProcessOverloadCandidates(Sema & S,unsigned CurrentArg,OverloadCandidate * Candidates,unsigned NumCandidates,SourceLocation OpenParLoc,bool Braced)656e5dd7070Spatrick     void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg,
657e5dd7070Spatrick                                    OverloadCandidate *Candidates,
658e5dd7070Spatrick                                    unsigned NumCandidates,
659*12c85518Srobert                                    SourceLocation OpenParLoc,
660*12c85518Srobert                                    bool Braced) override {
661e5dd7070Spatrick       StoredResults.reserve(StoredResults.size() + NumCandidates);
662e5dd7070Spatrick       for (unsigned I = 0; I != NumCandidates; ++I) {
663*12c85518Srobert         CodeCompletionString *StoredCompletion =
664*12c85518Srobert             Candidates[I].CreateSignatureString(CurrentArg, S, getAllocator(),
665e5dd7070Spatrick                                                 getCodeCompletionTUInfo(),
666*12c85518Srobert                                                 includeBriefComments(), Braced);
667e5dd7070Spatrick 
668e5dd7070Spatrick         CXCompletionResult R;
669e5dd7070Spatrick         R.CursorKind = CXCursor_OverloadCandidate;
670e5dd7070Spatrick         R.CompletionString = StoredCompletion;
671e5dd7070Spatrick         StoredResults.push_back(R);
672e5dd7070Spatrick       }
673e5dd7070Spatrick     }
674e5dd7070Spatrick 
getAllocator()675e5dd7070Spatrick     CodeCompletionAllocator &getAllocator() override {
676e5dd7070Spatrick       return *AllocatedResults.CodeCompletionAllocator;
677e5dd7070Spatrick     }
678e5dd7070Spatrick 
getCodeCompletionTUInfo()679e5dd7070Spatrick     CodeCompletionTUInfo &getCodeCompletionTUInfo() override { return CCTUInfo;}
680e5dd7070Spatrick 
681e5dd7070Spatrick   private:
Finish()682e5dd7070Spatrick     void Finish() {
683e5dd7070Spatrick       AllocatedResults.Results = new CXCompletionResult [StoredResults.size()];
684e5dd7070Spatrick       AllocatedResults.NumResults = StoredResults.size();
685e5dd7070Spatrick       std::memcpy(AllocatedResults.Results, StoredResults.data(),
686e5dd7070Spatrick                   StoredResults.size() * sizeof(CXCompletionResult));
687e5dd7070Spatrick       StoredResults.clear();
688e5dd7070Spatrick     }
689e5dd7070Spatrick   };
690e5dd7070Spatrick }
691e5dd7070Spatrick 
692e5dd7070Spatrick static CXCodeCompleteResults *
clang_codeCompleteAt_Impl(CXTranslationUnit TU,const char * complete_filename,unsigned complete_line,unsigned complete_column,ArrayRef<CXUnsavedFile> unsaved_files,unsigned options)693e5dd7070Spatrick clang_codeCompleteAt_Impl(CXTranslationUnit TU, const char *complete_filename,
694e5dd7070Spatrick                           unsigned complete_line, unsigned complete_column,
695e5dd7070Spatrick                           ArrayRef<CXUnsavedFile> unsaved_files,
696e5dd7070Spatrick                           unsigned options) {
697e5dd7070Spatrick   bool IncludeBriefComments = options & CXCodeComplete_IncludeBriefComments;
698e5dd7070Spatrick   bool SkipPreamble = options & CXCodeComplete_SkipPreamble;
699e5dd7070Spatrick   bool IncludeFixIts = options & CXCodeComplete_IncludeCompletionsWithFixIts;
700e5dd7070Spatrick 
701e5dd7070Spatrick #ifdef UDP_CODE_COMPLETION_LOGGER
702e5dd7070Spatrick #ifdef UDP_CODE_COMPLETION_LOGGER_PORT
703e5dd7070Spatrick   const llvm::TimeRecord &StartTime =  llvm::TimeRecord::getCurrentTime();
704e5dd7070Spatrick #endif
705e5dd7070Spatrick #endif
706e5dd7070Spatrick   bool EnableLogging = getenv("LIBCLANG_CODE_COMPLETION_LOGGING") != nullptr;
707e5dd7070Spatrick 
708e5dd7070Spatrick   if (cxtu::isNotUsableTU(TU)) {
709e5dd7070Spatrick     LOG_BAD_TU(TU);
710e5dd7070Spatrick     return nullptr;
711e5dd7070Spatrick   }
712e5dd7070Spatrick 
713e5dd7070Spatrick   ASTUnit *AST = cxtu::getASTUnit(TU);
714e5dd7070Spatrick   if (!AST)
715e5dd7070Spatrick     return nullptr;
716e5dd7070Spatrick 
717e5dd7070Spatrick   CIndexer *CXXIdx = TU->CIdx;
718e5dd7070Spatrick   if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
719e5dd7070Spatrick     setThreadBackgroundPriority();
720e5dd7070Spatrick 
721e5dd7070Spatrick   ASTUnit::ConcurrencyCheck Check(*AST);
722e5dd7070Spatrick 
723e5dd7070Spatrick   // Perform the remapping of source files.
724e5dd7070Spatrick   SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
725e5dd7070Spatrick 
726e5dd7070Spatrick   for (auto &UF : unsaved_files) {
727e5dd7070Spatrick     std::unique_ptr<llvm::MemoryBuffer> MB =
728e5dd7070Spatrick         llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
729e5dd7070Spatrick     RemappedFiles.push_back(std::make_pair(UF.Filename, MB.release()));
730e5dd7070Spatrick   }
731e5dd7070Spatrick 
732e5dd7070Spatrick   if (EnableLogging) {
733e5dd7070Spatrick     // FIXME: Add logging.
734e5dd7070Spatrick   }
735e5dd7070Spatrick 
736e5dd7070Spatrick   // Parse the resulting source file to find code-completion results.
737e5dd7070Spatrick   AllocatedCXCodeCompleteResults *Results = new AllocatedCXCodeCompleteResults(
738e5dd7070Spatrick       &AST->getFileManager());
739e5dd7070Spatrick   Results->Results = nullptr;
740e5dd7070Spatrick   Results->NumResults = 0;
741e5dd7070Spatrick 
742e5dd7070Spatrick   // Create a code-completion consumer to capture the results.
743e5dd7070Spatrick   CodeCompleteOptions Opts;
744e5dd7070Spatrick   Opts.IncludeBriefComments = IncludeBriefComments;
745e5dd7070Spatrick   Opts.LoadExternal = !SkipPreamble;
746e5dd7070Spatrick   Opts.IncludeFixIts = IncludeFixIts;
747e5dd7070Spatrick   CaptureCompletionResults Capture(Opts, *Results, &TU);
748e5dd7070Spatrick 
749e5dd7070Spatrick   // Perform completion.
750e5dd7070Spatrick   std::vector<const char *> CArgs;
751e5dd7070Spatrick   for (const auto &Arg : TU->Arguments)
752e5dd7070Spatrick     CArgs.push_back(Arg.c_str());
753e5dd7070Spatrick   std::string CompletionInvocation =
754e5dd7070Spatrick       llvm::formatv("-code-completion-at={0}:{1}:{2}", complete_filename,
755e5dd7070Spatrick                     complete_line, complete_column)
756e5dd7070Spatrick           .str();
757e5dd7070Spatrick   LibclangInvocationReporter InvocationReporter(
758e5dd7070Spatrick       *CXXIdx, LibclangInvocationReporter::OperationKind::CompletionOperation,
759e5dd7070Spatrick       TU->ParsingOptions, CArgs, CompletionInvocation, unsaved_files);
760e5dd7070Spatrick   AST->CodeComplete(complete_filename, complete_line, complete_column,
761e5dd7070Spatrick                     RemappedFiles, (options & CXCodeComplete_IncludeMacros),
762e5dd7070Spatrick                     (options & CXCodeComplete_IncludeCodePatterns),
763e5dd7070Spatrick                     IncludeBriefComments, Capture,
764e5dd7070Spatrick                     CXXIdx->getPCHContainerOperations(), *Results->Diag,
765e5dd7070Spatrick                     Results->LangOpts, *Results->SourceMgr, *Results->FileMgr,
766e5dd7070Spatrick                     Results->Diagnostics, Results->TemporaryBuffers);
767e5dd7070Spatrick 
768e5dd7070Spatrick   Results->DiagnosticsWrappers.resize(Results->Diagnostics.size());
769e5dd7070Spatrick 
770e5dd7070Spatrick   // Keep a reference to the allocator used for cached global completions, so
771e5dd7070Spatrick   // that we can be sure that the memory used by our code completion strings
772e5dd7070Spatrick   // doesn't get freed due to subsequent reparses (while the code completion
773e5dd7070Spatrick   // results are still active).
774e5dd7070Spatrick   Results->CachedCompletionAllocator = AST->getCachedCompletionAllocator();
775e5dd7070Spatrick 
776e5dd7070Spatrick 
777e5dd7070Spatrick 
778e5dd7070Spatrick #ifdef UDP_CODE_COMPLETION_LOGGER
779e5dd7070Spatrick #ifdef UDP_CODE_COMPLETION_LOGGER_PORT
780e5dd7070Spatrick   const llvm::TimeRecord &EndTime =  llvm::TimeRecord::getCurrentTime();
781e5dd7070Spatrick   SmallString<256> LogResult;
782e5dd7070Spatrick   llvm::raw_svector_ostream os(LogResult);
783e5dd7070Spatrick 
784e5dd7070Spatrick   // Figure out the language and whether or not it uses PCH.
785e5dd7070Spatrick   const char *lang = 0;
786e5dd7070Spatrick   bool usesPCH = false;
787e5dd7070Spatrick 
788e5dd7070Spatrick   for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
789e5dd7070Spatrick        I != E; ++I) {
790e5dd7070Spatrick     if (*I == 0)
791e5dd7070Spatrick       continue;
792e5dd7070Spatrick     if (strcmp(*I, "-x") == 0) {
793e5dd7070Spatrick       if (I + 1 != E) {
794e5dd7070Spatrick         lang = *(++I);
795e5dd7070Spatrick         continue;
796e5dd7070Spatrick       }
797e5dd7070Spatrick     }
798e5dd7070Spatrick     else if (strcmp(*I, "-include") == 0) {
799e5dd7070Spatrick       if (I+1 != E) {
800e5dd7070Spatrick         const char *arg = *(++I);
801e5dd7070Spatrick         SmallString<512> pchName;
802e5dd7070Spatrick         {
803e5dd7070Spatrick           llvm::raw_svector_ostream os(pchName);
804e5dd7070Spatrick           os << arg << ".pth";
805e5dd7070Spatrick         }
806e5dd7070Spatrick         pchName.push_back('\0');
807e5dd7070Spatrick         llvm::sys::fs::file_status stat_results;
808e5dd7070Spatrick         if (!llvm::sys::fs::status(pchName, stat_results))
809e5dd7070Spatrick           usesPCH = true;
810e5dd7070Spatrick         continue;
811e5dd7070Spatrick       }
812e5dd7070Spatrick     }
813e5dd7070Spatrick   }
814e5dd7070Spatrick 
815e5dd7070Spatrick   os << "{ ";
816e5dd7070Spatrick   os << "\"wall\": " << (EndTime.getWallTime() - StartTime.getWallTime());
817e5dd7070Spatrick   os << ", \"numRes\": " << Results->NumResults;
818e5dd7070Spatrick   os << ", \"diags\": " << Results->Diagnostics.size();
819e5dd7070Spatrick   os << ", \"pch\": " << (usesPCH ? "true" : "false");
820e5dd7070Spatrick   os << ", \"lang\": \"" << (lang ? lang : "<unknown>") << '"';
821e5dd7070Spatrick   const char *name = getlogin();
822e5dd7070Spatrick   os << ", \"user\": \"" << (name ? name : "unknown") << '"';
823e5dd7070Spatrick   os << ", \"clangVer\": \"" << getClangFullVersion() << '"';
824e5dd7070Spatrick   os << " }";
825e5dd7070Spatrick 
826e5dd7070Spatrick   StringRef res = os.str();
827e5dd7070Spatrick   if (res.size() > 0) {
828e5dd7070Spatrick     do {
829e5dd7070Spatrick       // Setup the UDP socket.
830e5dd7070Spatrick       struct sockaddr_in servaddr;
831e5dd7070Spatrick       bzero(&servaddr, sizeof(servaddr));
832e5dd7070Spatrick       servaddr.sin_family = AF_INET;
833e5dd7070Spatrick       servaddr.sin_port = htons(UDP_CODE_COMPLETION_LOGGER_PORT);
834e5dd7070Spatrick       if (inet_pton(AF_INET, UDP_CODE_COMPLETION_LOGGER,
835e5dd7070Spatrick                     &servaddr.sin_addr) <= 0)
836e5dd7070Spatrick         break;
837e5dd7070Spatrick 
838e5dd7070Spatrick       int sockfd = socket(AF_INET, SOCK_DGRAM, 0);
839e5dd7070Spatrick       if (sockfd < 0)
840e5dd7070Spatrick         break;
841e5dd7070Spatrick 
842e5dd7070Spatrick       sendto(sockfd, res.data(), res.size(), 0,
843e5dd7070Spatrick              (struct sockaddr *)&servaddr, sizeof(servaddr));
844e5dd7070Spatrick       close(sockfd);
845e5dd7070Spatrick     }
846e5dd7070Spatrick     while (false);
847e5dd7070Spatrick   }
848e5dd7070Spatrick #endif
849e5dd7070Spatrick #endif
850e5dd7070Spatrick   return Results;
851e5dd7070Spatrick }
852e5dd7070Spatrick 
clang_codeCompleteAt(CXTranslationUnit TU,const char * complete_filename,unsigned complete_line,unsigned complete_column,struct CXUnsavedFile * unsaved_files,unsigned num_unsaved_files,unsigned options)853e5dd7070Spatrick CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
854e5dd7070Spatrick                                             const char *complete_filename,
855e5dd7070Spatrick                                             unsigned complete_line,
856e5dd7070Spatrick                                             unsigned complete_column,
857e5dd7070Spatrick                                             struct CXUnsavedFile *unsaved_files,
858e5dd7070Spatrick                                             unsigned num_unsaved_files,
859e5dd7070Spatrick                                             unsigned options) {
860e5dd7070Spatrick   LOG_FUNC_SECTION {
861e5dd7070Spatrick     *Log << TU << ' '
862e5dd7070Spatrick          << complete_filename << ':' << complete_line << ':' << complete_column;
863e5dd7070Spatrick   }
864e5dd7070Spatrick 
865e5dd7070Spatrick   if (num_unsaved_files && !unsaved_files)
866e5dd7070Spatrick     return nullptr;
867e5dd7070Spatrick 
868e5dd7070Spatrick   CXCodeCompleteResults *result;
869e5dd7070Spatrick   auto CodeCompleteAtImpl = [=, &result]() {
870e5dd7070Spatrick     result = clang_codeCompleteAt_Impl(
871e5dd7070Spatrick         TU, complete_filename, complete_line, complete_column,
872*12c85518Srobert         llvm::ArrayRef(unsaved_files, num_unsaved_files), options);
873e5dd7070Spatrick   };
874e5dd7070Spatrick 
875e5dd7070Spatrick   llvm::CrashRecoveryContext CRC;
876e5dd7070Spatrick 
877e5dd7070Spatrick   if (!RunSafely(CRC, CodeCompleteAtImpl)) {
878e5dd7070Spatrick     fprintf(stderr, "libclang: crash detected in code completion\n");
879e5dd7070Spatrick     cxtu::getASTUnit(TU)->setUnsafeToFree(true);
880e5dd7070Spatrick     return nullptr;
881e5dd7070Spatrick   } else if (getenv("LIBCLANG_RESOURCE_USAGE"))
882e5dd7070Spatrick     PrintLibclangResourceUsage(TU);
883e5dd7070Spatrick 
884e5dd7070Spatrick   return result;
885e5dd7070Spatrick }
886e5dd7070Spatrick 
clang_defaultCodeCompleteOptions(void)887e5dd7070Spatrick unsigned clang_defaultCodeCompleteOptions(void) {
888e5dd7070Spatrick   return CXCodeComplete_IncludeMacros;
889e5dd7070Spatrick }
890e5dd7070Spatrick 
clang_disposeCodeCompleteResults(CXCodeCompleteResults * ResultsIn)891e5dd7070Spatrick void clang_disposeCodeCompleteResults(CXCodeCompleteResults *ResultsIn) {
892e5dd7070Spatrick   if (!ResultsIn)
893e5dd7070Spatrick     return;
894e5dd7070Spatrick 
895e5dd7070Spatrick   AllocatedCXCodeCompleteResults *Results
896e5dd7070Spatrick     = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
897e5dd7070Spatrick   delete Results;
898e5dd7070Spatrick }
899e5dd7070Spatrick 
900e5dd7070Spatrick unsigned
clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults * ResultsIn)901e5dd7070Spatrick clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *ResultsIn) {
902e5dd7070Spatrick   AllocatedCXCodeCompleteResults *Results
903e5dd7070Spatrick     = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
904e5dd7070Spatrick   if (!Results)
905e5dd7070Spatrick     return 0;
906e5dd7070Spatrick 
907e5dd7070Spatrick   return Results->Diagnostics.size();
908e5dd7070Spatrick }
909e5dd7070Spatrick 
910e5dd7070Spatrick CXDiagnostic
clang_codeCompleteGetDiagnostic(CXCodeCompleteResults * ResultsIn,unsigned Index)911e5dd7070Spatrick clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *ResultsIn,
912e5dd7070Spatrick                                 unsigned Index) {
913e5dd7070Spatrick   AllocatedCXCodeCompleteResults *Results
914e5dd7070Spatrick     = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
915e5dd7070Spatrick   if (!Results || Index >= Results->Diagnostics.size())
916e5dd7070Spatrick     return nullptr;
917e5dd7070Spatrick 
918ec727ea7Spatrick   CXStoredDiagnostic *Diag = Results->DiagnosticsWrappers[Index].get();
919e5dd7070Spatrick   if (!Diag)
920ec727ea7Spatrick     Diag = (Results->DiagnosticsWrappers[Index] =
921ec727ea7Spatrick                 std::make_unique<CXStoredDiagnostic>(
922ec727ea7Spatrick                     Results->Diagnostics[Index], Results->LangOpts))
923ec727ea7Spatrick                .get();
924e5dd7070Spatrick   return Diag;
925e5dd7070Spatrick }
926e5dd7070Spatrick 
927e5dd7070Spatrick unsigned long long
clang_codeCompleteGetContexts(CXCodeCompleteResults * ResultsIn)928e5dd7070Spatrick clang_codeCompleteGetContexts(CXCodeCompleteResults *ResultsIn) {
929e5dd7070Spatrick   AllocatedCXCodeCompleteResults *Results
930e5dd7070Spatrick     = static_cast<AllocatedCXCodeCompleteResults*>(ResultsIn);
931e5dd7070Spatrick   if (!Results)
932e5dd7070Spatrick     return 0;
933e5dd7070Spatrick 
934e5dd7070Spatrick   return Results->Contexts;
935e5dd7070Spatrick }
936e5dd7070Spatrick 
clang_codeCompleteGetContainerKind(CXCodeCompleteResults * ResultsIn,unsigned * IsIncomplete)937e5dd7070Spatrick enum CXCursorKind clang_codeCompleteGetContainerKind(
938e5dd7070Spatrick                                                CXCodeCompleteResults *ResultsIn,
939e5dd7070Spatrick                                                      unsigned *IsIncomplete) {
940e5dd7070Spatrick   AllocatedCXCodeCompleteResults *Results =
941e5dd7070Spatrick     static_cast<AllocatedCXCodeCompleteResults *>(ResultsIn);
942e5dd7070Spatrick   if (!Results)
943e5dd7070Spatrick     return CXCursor_InvalidCode;
944e5dd7070Spatrick 
945e5dd7070Spatrick   if (IsIncomplete != nullptr) {
946e5dd7070Spatrick     *IsIncomplete = Results->ContainerIsIncomplete;
947e5dd7070Spatrick   }
948e5dd7070Spatrick 
949e5dd7070Spatrick   return Results->ContainerKind;
950e5dd7070Spatrick }
951e5dd7070Spatrick 
clang_codeCompleteGetContainerUSR(CXCodeCompleteResults * ResultsIn)952e5dd7070Spatrick CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *ResultsIn) {
953e5dd7070Spatrick   AllocatedCXCodeCompleteResults *Results =
954e5dd7070Spatrick     static_cast<AllocatedCXCodeCompleteResults *>(ResultsIn);
955e5dd7070Spatrick   if (!Results)
956e5dd7070Spatrick     return cxstring::createEmpty();
957e5dd7070Spatrick 
958e5dd7070Spatrick   return cxstring::createRef(Results->ContainerUSR.c_str());
959e5dd7070Spatrick }
960e5dd7070Spatrick 
961e5dd7070Spatrick 
clang_codeCompleteGetObjCSelector(CXCodeCompleteResults * ResultsIn)962e5dd7070Spatrick CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *ResultsIn) {
963e5dd7070Spatrick   AllocatedCXCodeCompleteResults *Results =
964e5dd7070Spatrick     static_cast<AllocatedCXCodeCompleteResults *>(ResultsIn);
965e5dd7070Spatrick   if (!Results)
966e5dd7070Spatrick     return cxstring::createEmpty();
967e5dd7070Spatrick 
968e5dd7070Spatrick   return cxstring::createDup(Results->Selector);
969e5dd7070Spatrick }
970e5dd7070Spatrick 
971e5dd7070Spatrick /// Simple utility function that appends a \p New string to the given
972e5dd7070Spatrick /// \p Old string, using the \p Buffer for storage.
973e5dd7070Spatrick ///
974e5dd7070Spatrick /// \param Old The string to which we are appending. This parameter will be
975e5dd7070Spatrick /// updated to reflect the complete string.
976e5dd7070Spatrick ///
977e5dd7070Spatrick ///
978e5dd7070Spatrick /// \param New The string to append to \p Old.
979e5dd7070Spatrick ///
980e5dd7070Spatrick /// \param Buffer A buffer that stores the actual, concatenated string. It will
981e5dd7070Spatrick /// be used if the old string is already-non-empty.
AppendToString(StringRef & Old,StringRef New,SmallString<256> & Buffer)982e5dd7070Spatrick static void AppendToString(StringRef &Old, StringRef New,
983e5dd7070Spatrick                            SmallString<256> &Buffer) {
984e5dd7070Spatrick   if (Old.empty()) {
985e5dd7070Spatrick     Old = New;
986e5dd7070Spatrick     return;
987e5dd7070Spatrick   }
988e5dd7070Spatrick 
989e5dd7070Spatrick   if (Buffer.empty())
990e5dd7070Spatrick     Buffer.append(Old.begin(), Old.end());
991e5dd7070Spatrick   Buffer.append(New.begin(), New.end());
992e5dd7070Spatrick   Old = Buffer.str();
993e5dd7070Spatrick }
994e5dd7070Spatrick 
995e5dd7070Spatrick /// Get the typed-text blocks from the given code-completion string
996e5dd7070Spatrick /// and return them as a single string.
997e5dd7070Spatrick ///
998e5dd7070Spatrick /// \param String The code-completion string whose typed-text blocks will be
999e5dd7070Spatrick /// concatenated.
1000e5dd7070Spatrick ///
1001e5dd7070Spatrick /// \param Buffer A buffer used for storage of the completed name.
GetTypedName(CodeCompletionString * String,SmallString<256> & Buffer)1002e5dd7070Spatrick static StringRef GetTypedName(CodeCompletionString *String,
1003e5dd7070Spatrick                                     SmallString<256> &Buffer) {
1004e5dd7070Spatrick   StringRef Result;
1005e5dd7070Spatrick   for (CodeCompletionString::iterator C = String->begin(), CEnd = String->end();
1006e5dd7070Spatrick        C != CEnd; ++C) {
1007e5dd7070Spatrick     if (C->Kind == CodeCompletionString::CK_TypedText)
1008e5dd7070Spatrick       AppendToString(Result, C->Text, Buffer);
1009e5dd7070Spatrick   }
1010e5dd7070Spatrick 
1011e5dd7070Spatrick   return Result;
1012e5dd7070Spatrick }
1013e5dd7070Spatrick 
1014e5dd7070Spatrick namespace {
1015e5dd7070Spatrick   struct OrderCompletionResults {
operator ()__anon888fdb060411::OrderCompletionResults1016e5dd7070Spatrick     bool operator()(const CXCompletionResult &XR,
1017e5dd7070Spatrick                     const CXCompletionResult &YR) const {
1018e5dd7070Spatrick       CodeCompletionString *X
1019e5dd7070Spatrick         = (CodeCompletionString *)XR.CompletionString;
1020e5dd7070Spatrick       CodeCompletionString *Y
1021e5dd7070Spatrick         = (CodeCompletionString *)YR.CompletionString;
1022e5dd7070Spatrick 
1023e5dd7070Spatrick       SmallString<256> XBuffer;
1024e5dd7070Spatrick       StringRef XText = GetTypedName(X, XBuffer);
1025e5dd7070Spatrick       SmallString<256> YBuffer;
1026e5dd7070Spatrick       StringRef YText = GetTypedName(Y, YBuffer);
1027e5dd7070Spatrick 
1028e5dd7070Spatrick       if (XText.empty() || YText.empty())
1029e5dd7070Spatrick         return !XText.empty();
1030e5dd7070Spatrick 
1031a9ac8606Spatrick       int result = XText.compare_insensitive(YText);
1032e5dd7070Spatrick       if (result < 0)
1033e5dd7070Spatrick         return true;
1034e5dd7070Spatrick       if (result > 0)
1035e5dd7070Spatrick         return false;
1036e5dd7070Spatrick 
1037e5dd7070Spatrick       result = XText.compare(YText);
1038e5dd7070Spatrick       return result < 0;
1039e5dd7070Spatrick     }
1040e5dd7070Spatrick   };
1041e5dd7070Spatrick }
1042e5dd7070Spatrick 
clang_sortCodeCompletionResults(CXCompletionResult * Results,unsigned NumResults)1043e5dd7070Spatrick void clang_sortCodeCompletionResults(CXCompletionResult *Results,
1044e5dd7070Spatrick                                      unsigned NumResults) {
1045e5dd7070Spatrick   std::stable_sort(Results, Results + NumResults, OrderCompletionResults());
1046e5dd7070Spatrick }
1047