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