[SourceKit] Add option to enable ASTContext reusing for code completion

Author: rintaro

include/swift/IDE/CompletionInstance.h

@@ -36,6 +36,7 @@ makeCodeCompletionMemoryBuffer(const llvm::MemoryBuffer *origBuf,
 
 class CompletionInstance {
   std::unique_ptr<CompilerInstance> CachedCI = nullptr;
+  bool EnableASTCaching = false;
 
   swift::CompilerInstance *
   getReusingCompilerInstance(const swift::CompilerInvocation &Invocation,
@@ -49,6 +50,10 @@ class CompletionInstance {
       std::string &Error, DiagnosticConsumer *DiagC);
 
 public:
+  void setEnableASTCaching(bool Flag) {
+    EnableASTCaching = Flag;
+  }
+
   swift::CompilerInstance *getCompilerInstance(
       swift::CompilerInvocation &Invocation,
       llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem,

lib/IDE/CompletionInstance.cpp

@@ -130,6 +130,9 @@ CompilerInstance *CompletionInstance::getReusingCompilerInstance(
     const swift::CompilerInvocation &Invocation,
     llvm::MemoryBuffer *completionBuffer, unsigned int Offset,
     DiagnosticConsumer *DiagC) {
+  if (!EnableASTCaching)
+    return nullptr;
+
   if (!CachedCI)
     return nullptr;
 

tools/SourceKit/include/SourceKit/Core/LangSupport.h

@@ -653,6 +653,7 @@ class LangSupport {
 
   virtual void
   codeComplete(llvm::MemoryBuffer *InputBuf, unsigned Offset,
+               OptionsDictionary *options,
                CodeCompletionConsumer &Consumer, ArrayRef<const char *> Args,
                Optional<VFSOptions> vfsOptions) = 0;
 

tools/SourceKit/lib/SwiftLang/CodeCompletionOrganizer.h

@@ -42,6 +42,7 @@ struct Options {
   bool hideLowPriority = true;
   bool hideByNameStyle = true;
   bool fuzzyMatching = true;
+  bool reuseASTContextIfPossible = false;
   unsigned minFuzzyLength = 2;
   unsigned showTopNonLiteralResults = 3;
 

tools/SourceKit/lib/SwiftLang/SwiftCompletion.cpp

@@ -199,11 +199,29 @@ static bool swiftCodeCompleteImpl(
   return true;
 }
 
+static void translateCodeCompletionOptions(OptionsDictionary &from,
+                                           CodeCompletion::Options &to,
+                                           StringRef &filterText,
+                                           unsigned &resultOffset,
+                                           unsigned &maxResults);
+
 void SwiftLangSupport::codeComplete(
     llvm::MemoryBuffer *UnresolvedInputFile, unsigned Offset,
+    OptionsDictionary *options,
     SourceKit::CodeCompletionConsumer &SKConsumer, ArrayRef<const char *> Args,
     Optional<VFSOptions> vfsOptions) {
 
+
+  CodeCompletion::Options CCOpts;
+  if (options) {
+    StringRef filterText;
+    unsigned resultOffset = 0;
+    unsigned maxResults = 0;
+    translateCodeCompletionOptions(*options, CCOpts, filterText, resultOffset,
+                                   maxResults);
+  }
+  CompletionInst->setEnableASTCaching(CCOpts.reuseASTContextIfPossible);
+
   std::string error;
   // FIXME: the use of None as primary file is to match the fact we do not read
   // the document contents using the editor documents infrastructure.
@@ -823,6 +841,7 @@ static void translateCodeCompletionOptions(OptionsDictionary &from,
   static UIdent KeyContextWeight("key.codecomplete.sort.contextweight");
   static UIdent KeyFuzzyWeight("key.codecomplete.sort.fuzzyweight");
   static UIdent KeyPopularityBonus("key.codecomplete.sort.popularitybonus");
+  static UIdent KeyReuseASTContext("key.codecomplete.reuseastcontext");
   from.valueForOption(KeySortByName, to.sortByName);
   from.valueForOption(KeyUseImportDepth, to.useImportDepth);
   from.valueForOption(KeyGroupOverloads, to.groupOverloads);
@@ -846,6 +865,7 @@ static void translateCodeCompletionOptions(OptionsDictionary &from,
   from.valueForOption(KeyPopularityBonus, to.popularityBonus);
   from.valueForOption(KeyHideByName, to.hideByNameStyle);
   from.valueForOption(KeyTopNonLiteral, to.showTopNonLiteralResults);
+  from.valueForOption(KeyReuseASTContext, to.reuseASTContextIfPossible);
 }
 
 /// Canonicalize a name that is in the format of a reference to a function into
@@ -1164,6 +1184,7 @@ void SwiftLangSupport::codeCompleteOpen(
   if (options)
     translateCodeCompletionOptions(*options, CCOpts, filterText, resultOffset,
                                    maxResults);
+  CompletionInst->setEnableASTCaching(CCOpts.reuseASTContextIfPossible);
 
   std::string error;
   // FIXME: the use of None as primary file is to match the fact we do not read
@@ -1284,6 +1305,7 @@ void SwiftLangSupport::codeCompleteUpdate(
   if (options)
     translateCodeCompletionOptions(*options, CCOpts, filterText, resultOffset,
                                    maxResults);
+  CompletionInst->setEnableASTCaching(CCOpts.reuseASTContextIfPossible);
 
   NameToPopularityMap *nameToPopularity = nullptr;
   // This reference must outlive the uses of nameToPopularity.

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.h

@@ -445,6 +445,7 @@ class SwiftLangSupport : public LangSupport {
 
   void codeComplete(
       llvm::MemoryBuffer *InputBuf, unsigned Offset,
+      OptionsDictionary *options,
       SourceKit::CodeCompletionConsumer &Consumer, ArrayRef<const char *> Args,
       Optional<VFSOptions> vfsOptions) override;
 

tools/SourceKit/tools/sourcekitd/lib/API/Requests.cpp

@@ -158,6 +158,7 @@ static void findRelatedIdents(StringRef Filename,
 
 static sourcekitd_response_t
 codeComplete(llvm::MemoryBuffer *InputBuf, int64_t Offset,
+             Optional<RequestDict> optionsDict,
              ArrayRef<const char *> Args, Optional<VFSOptions> vfsOptions);
 
 static sourcekitd_response_t codeCompleteOpen(StringRef name,
@@ -940,7 +941,9 @@ static void handleSemanticRequest(
     int64_t Offset;
     if (Req.getInt64(KeyOffset, Offset, /*isOptional=*/false))
       return Rec(createErrorRequestInvalid("missing 'key.offset'"));
-    return Rec(codeComplete(InputBuf.get(), Offset, Args, std::move(vfsOptions)));
+    Optional<RequestDict> options = Req.getDictionary(KeyCodeCompleteOptions);
+    return Rec(codeComplete(InputBuf.get(), Offset, options, Args,
+                            std::move(vfsOptions)));
   }
 
   if (ReqUID == RequestCodeCompleteOpen) {
@@ -1932,12 +1935,19 @@ class SKCodeCompletionConsumer : public CodeCompletionConsumer {
 
 static sourcekitd_response_t
 codeComplete(llvm::MemoryBuffer *InputBuf, int64_t Offset,
+             Optional<RequestDict> optionsDict,
              ArrayRef<const char *> Args,
              Optional<VFSOptions> vfsOptions) {
   ResponseBuilder RespBuilder;
   SKCodeCompletionConsumer CCC(RespBuilder);
+
+  std::unique_ptr<SKOptionsDictionary> options;
+  if (optionsDict)
+    options = std::make_unique<SKOptionsDictionary>(*optionsDict);
+
   LangSupport &Lang = getGlobalContext().getSwiftLangSupport();
-  Lang.codeComplete(InputBuf, Offset, CCC, Args, std::move(vfsOptions));
+  Lang.codeComplete(InputBuf, Offset, options.get(), CCC, Args,
+                    std::move(vfsOptions));
   return CCC.createResponse();
 }