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