[SourceKit] Explicitly specify frontend action type when creating compiler invocation

Explicitly specify the frontend action to make sure we aren’t loading thes stdlib if the performed action is syntactic only.

Author: ahoppen

include/swift/IDE/Utils.h

@@ -20,6 +20,7 @@
 #include "swift/AST/Effects.h"
 #include "swift/AST/Module.h"
 #include "swift/AST/ASTPrinter.h"
+#include "swift/Frontend/FrontendOptions.h"
 #include "swift/IDE/SourceEntityWalker.h"
 #include "swift/Parse/Token.h"
 #include "llvm/ADT/StringRef.h"
@@ -85,7 +86,8 @@ SourceCompleteResult isSourceInputComplete(StringRef Text, SourceFileKind SFKind
 
 bool initCompilerInvocation(
     CompilerInvocation &Invocation, ArrayRef<const char *> OrigArgs,
-    DiagnosticEngine &Diags, StringRef UnresolvedPrimaryFile,
+    FrontendOptions::ActionType Action, DiagnosticEngine &Diags,
+    StringRef UnresolvedPrimaryFile,
     llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem,
     const std::string &runtimeResourcePath,
     const std::string &diagnosticDocumentationPath, time_t sessionTimestamp,

lib/IDE/Utils.cpp

@@ -273,7 +273,8 @@ class StreamDiagConsumer : public DiagnosticConsumer {
 
 bool ide::initCompilerInvocation(
     CompilerInvocation &Invocation, ArrayRef<const char *> OrigArgs,
-    DiagnosticEngine &Diags, StringRef UnresolvedPrimaryFile,
+    FrontendOptions::ActionType Action, DiagnosticEngine &Diags,
+    StringRef UnresolvedPrimaryFile,
     llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem,
     const std::string &runtimeResourcePath,
     const std::string &diagnosticDocumentationPath, time_t sessionTimestamp,

tools/SourceKit/lib/SwiftLang/SwiftASTManager.cpp

@@ -650,42 +650,43 @@ convertFileContentsToInputs(ArrayRef<FileContent> contents) {
 
 bool SwiftASTManager::initCompilerInvocation(
     CompilerInvocation &Invocation, ArrayRef<const char *> OrigArgs,
-    DiagnosticEngine &Diags, StringRef UnresolvedPrimaryFile,
-    std::string &Error) {
-  return initCompilerInvocation(Invocation, OrigArgs, Diags,
+    swift::FrontendOptions::ActionType Action, DiagnosticEngine &Diags,
+    StringRef UnresolvedPrimaryFile, std::string &Error) {
+  return initCompilerInvocation(Invocation, OrigArgs, Action, Diags,
                                 UnresolvedPrimaryFile,
-                                llvm::vfs::getRealFileSystem(),
-                                Error);
+                                llvm::vfs::getRealFileSystem(), Error);
 }
 
 bool SwiftASTManager::initCompilerInvocation(
     CompilerInvocation &Invocation, ArrayRef<const char *> OrigArgs,
-    DiagnosticEngine &Diags, StringRef UnresolvedPrimaryFile,
+    FrontendOptions::ActionType Action, DiagnosticEngine &Diags,
+    StringRef UnresolvedPrimaryFile,
     llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem,
     std::string &Error) {
   return ide::initCompilerInvocation(
-      Invocation, OrigArgs, Diags, UnresolvedPrimaryFile, FileSystem,
+      Invocation, OrigArgs, Action, Diags, UnresolvedPrimaryFile, FileSystem,
       Impl.RuntimeResourcePath, Impl.DiagnosticDocumentationPath,
       Impl.SessionTimestamp, Error);
 }
 
-bool SwiftASTManager::initCompilerInvocation(CompilerInvocation &CompInvok,
-                                             ArrayRef<const char *> OrigArgs,
-                                             StringRef PrimaryFile,
-                                             std::string &Error) {
+bool SwiftASTManager::initCompilerInvocation(
+    CompilerInvocation &CompInvok, ArrayRef<const char *> OrigArgs,
+    swift::FrontendOptions::ActionType Action, StringRef PrimaryFile,
+    std::string &Error) {
   DiagnosticEngine Diagnostics(Impl.SourceMgr);
-  return initCompilerInvocation(CompInvok, OrigArgs, Diagnostics, PrimaryFile,
-                                Error);
+  return initCompilerInvocation(CompInvok, OrigArgs, Action, Diagnostics,
+                                PrimaryFile, Error);
 }
 
 bool SwiftASTManager::initCompilerInvocationNoInputs(
     swift::CompilerInvocation &Invocation, ArrayRef<const char *> OrigArgs,
-    swift::DiagnosticEngine &Diags, std::string &Error, bool AllowInputs) {
+    swift::FrontendOptions::ActionType Action, swift::DiagnosticEngine &Diags,
+    std::string &Error, bool AllowInputs) {
 
   SmallVector<const char *, 16> Args(OrigArgs.begin(), OrigArgs.end());
   // Use stdin as a .swift input to satisfy the driver.
   Args.push_back("-");
-  if (initCompilerInvocation(Invocation, Args, Diags, "", Error))
+  if (initCompilerInvocation(Invocation, Args, Action, Diags, "", Error))
     return true;
 
   if (!AllowInputs &&
@@ -699,13 +700,15 @@ bool SwiftASTManager::initCompilerInvocationNoInputs(
   return false;
 }
 
-SwiftInvocationRef SwiftASTManager::getInvocation(
-    ArrayRef<const char *> OrigArgs, StringRef PrimaryFile, std::string &Error) {
-  return getInvocation(OrigArgs, PrimaryFile, llvm::vfs::getRealFileSystem(),
-                       Error);
+SwiftInvocationRef
+SwiftASTManager::getTypecheckInvocation(ArrayRef<const char *> OrigArgs,
+                                        StringRef PrimaryFile,
+                                        std::string &Error) {
+  return getTypecheckInvocation(OrigArgs, PrimaryFile,
+                                llvm::vfs::getRealFileSystem(), Error);
 }
 
-SwiftInvocationRef SwiftASTManager::getInvocation(
+SwiftInvocationRef SwiftASTManager::getTypecheckInvocation(
     ArrayRef<const char *> OrigArgs, StringRef PrimaryFile,
     llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem,
     std::string &Error) {
@@ -716,8 +719,9 @@ SwiftInvocationRef SwiftASTManager::getInvocation(
   Diags.addConsumer(CollectDiagConsumer);
 
   CompilerInvocation CompInvok;
-  if (initCompilerInvocation(CompInvok, OrigArgs, Diags, PrimaryFile,
-                             FileSystem, Error)) {
+  if (initCompilerInvocation(CompInvok, OrigArgs,
+                             FrontendOptions::ActionType::Typecheck, Diags,
+                             PrimaryFile, FileSystem, Error)) {
     // We create a traced operation here to represent the failure to parse
     // arguments since we cannot reach `createAST` where that would normally
     // happen.

tools/SourceKit/lib/SwiftLang/SwiftASTManager.h

@@ -78,6 +78,7 @@
 #include "SourceKit/Core/LLVM.h"
 #include "SourceKit/Support/CancellationToken.h"
 #include "SwiftInvocation.h"
+#include "swift/Frontend/FrontendOptions.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/IntrusiveRefCntPtr.h"
 #include "llvm/ADT/StringRef.h"
@@ -238,12 +239,13 @@ class SwiftASTManager : public std::enable_shared_from_this<SwiftASTManager> {
                            StringRef DiagnosticDocumentationPath);
   ~SwiftASTManager();
 
-  SwiftInvocationRef getInvocation(
-      ArrayRef<const char *> Args, StringRef PrimaryFile, std::string &Error);
+  SwiftInvocationRef getTypecheckInvocation(ArrayRef<const char *> Args,
+                                            StringRef PrimaryFile,
+                                            std::string &Error);
 
   /// Same as the previous `getInvocation`, but allows the caller to specify a
   /// custom `FileSystem` to be used throughout the invocation.
-  SwiftInvocationRef getInvocation(
+  SwiftInvocationRef getTypecheckInvocation(
       ArrayRef<const char *> Args, StringRef PrimaryFile,
       llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem,
       std::string &Error);
@@ -262,29 +264,33 @@ class SwiftASTManager : public std::enable_shared_from_this<SwiftASTManager> {
   std::unique_ptr<llvm::MemoryBuffer> getMemoryBuffer(StringRef Filename,
                                                       std::string &Error);
 
-  bool initCompilerInvocation(
-      swift::CompilerInvocation &Invocation, ArrayRef<const char *> Args,
-      swift::DiagnosticEngine &Diags, StringRef PrimaryFile, std::string &Error);
+  bool initCompilerInvocation(swift::CompilerInvocation &Invocation,
+                              ArrayRef<const char *> Args,
+                              swift::FrontendOptions::ActionType Action,
+                              swift::DiagnosticEngine &Diags,
+                              StringRef PrimaryFile, std::string &Error);
 
   /// Same as the previous `initCompilerInvocation`, but allows the caller to
   /// specify a custom `FileSystem` to be used throughout the invocation.
   bool initCompilerInvocation(
       swift::CompilerInvocation &Invocation, ArrayRef<const char *> Args,
-      swift::DiagnosticEngine &Diags, StringRef PrimaryFile,
+      swift::FrontendOptions::ActionType Action, swift::DiagnosticEngine &Diags,
+      StringRef PrimaryFile,
       llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem,
       std::string &Error);
 
   bool initCompilerInvocation(swift::CompilerInvocation &CompInvok,
                               ArrayRef<const char *> OrigArgs,
-                              StringRef PrimaryFile,
-                              std::string &Error);
+                              swift::FrontendOptions::ActionType Action,
+                              StringRef PrimaryFile, std::string &Error);
 
   /// Initializes \p Invocation as if for typechecking, but with no inputs.
   ///
   /// If \p AllowInputs is false, it is an error for \p OrigArgs to contain any
   /// input files.
   bool initCompilerInvocationNoInputs(swift::CompilerInvocation &Invocation,
                                       ArrayRef<const char *> OrigArgs,
+                                      swift::FrontendOptions::ActionType Action,
                                       swift::DiagnosticEngine &Diags,
                                       std::string &Error,
                                       bool AllowInputs = true);

tools/SourceKit/lib/SwiftLang/SwiftDocSupport.cpp

@@ -1417,7 +1417,8 @@ void SwiftLangSupport::findLocalRenameRanges(
     ArrayRef<const char *> Args, SourceKitCancellationToken CancellationToken,
     CategorizedRenameRangesReceiver Receiver) {
   std::string Error;
-  SwiftInvocationRef Invok = ASTMgr->getInvocation(Args, Filename, Error);
+  SwiftInvocationRef Invok =
+      ASTMgr->getTypecheckInvocation(Args, Filename, Error);
   if (!Invok) {
     LOG_WARN_FUNC("failed to create an ASTInvocation: " << Error);
     Receiver(RequestResult<ArrayRef<CategorizedRenameRanges>>::fromError(Error));
@@ -1465,7 +1466,8 @@ SourceFile *SwiftLangSupport::getSyntacticSourceFile(
   CompilerInvocation Invocation;
 
   bool Failed = getASTManager()->initCompilerInvocationNoInputs(
-      Invocation, Args, ParseCI.getDiags(), Error);
+      Invocation, Args, FrontendOptions::ActionType::Parse, ParseCI.getDiags(),
+      Error);
   if (Failed) {
     Error = "Compiler invocation init failed";
     return nullptr;
@@ -1518,7 +1520,8 @@ void SwiftLangSupport::getDocInfo(llvm::MemoryBuffer *InputBuf,
   CompilerInvocation Invocation;
   std::string Error;
   bool Failed = getASTManager()->initCompilerInvocationNoInputs(
-      Invocation, Args, CI.getDiags(), Error, /*AllowInputs=*/false);
+      Invocation, Args, FrontendOptions::ActionType::Typecheck, CI.getDiags(),
+      Error, /*AllowInputs=*/false);
 
   if (Failed) {
     Consumer.failed(Error);
@@ -1551,8 +1554,9 @@ findModuleGroups(StringRef ModuleName, ArrayRef<const char *> Args,
   PrintingDiagnosticConsumer PrintDiags;
   CI.addDiagnosticConsumer(&PrintDiags);
   std::string Error;
-  if (getASTManager()->initCompilerInvocationNoInputs(Invocation, Args,
-                                                     CI.getDiags(), Error)) {
+  if (getASTManager()->initCompilerInvocationNoInputs(
+          Invocation, Args, FrontendOptions::ActionType::Typecheck,
+          CI.getDiags(), Error)) {
     Receiver(RequestResult<ArrayRef<StringRef>>::fromError(Error));
     return;
   }
@@ -1563,12 +1567,6 @@ findModuleGroups(StringRef ModuleName, ArrayRef<const char *> Args,
 
   // Load standard library so that Clang importer can use it.
   ASTContext &Ctx = CI.getASTContext();
-  auto *Stdlib = Ctx.getModuleByIdentifier(Ctx.StdlibModuleName);
-  if (!Stdlib) {
-    Error = "Cannot load stdlib.";
-    Receiver(RequestResult<ArrayRef<StringRef>>::fromError(Error));
-    return;
-  }
   auto *M = Ctx.getModuleByName(ModuleName);
   if (!M) {
     Error = "Cannot find the module.";

tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp

@@ -654,7 +654,7 @@ class SwiftDocumentSemanticInfo :
   void setCompilerArgs(ArrayRef<const char *> Args) {
     if (auto ASTMgr = this->ASTMgr.lock()) {
       InvokRef =
-          ASTMgr->getInvocation(Args, Filename, CompilerArgsError);
+          ASTMgr->getTypecheckInvocation(Args, Filename, CompilerArgsError);
     }
   }
 
@@ -2015,8 +2015,8 @@ void SwiftEditorDocument::resetSyntaxInfo(ImmutableTextSnapshotRef Snapshot,
     Args.push_back("-");
     std::string Error;
     // Ignore possible error(s)
-    Lang.getASTManager()->
-      initCompilerInvocation(CompInv, Args, StringRef(), Error);
+    Lang.getASTManager()->initCompilerInvocation(
+        CompInv, Args, FrontendOptions::ActionType::Parse, StringRef(), Error);
   }
   CompInv.getLangOptions().BuildSyntaxTree = BuildSyntaxTree;
   CompInv.setMainFileSyntaxParsingCache(SyntaxCache);

tools/SourceKit/lib/SwiftLang/SwiftEditorInterfaceGen.cpp

@@ -634,8 +634,9 @@ void SwiftLangSupport::editorOpenTypeInterface(EditorConsumer &Consumer,
 
   CompilerInvocation Invocation;
   std::string Error;
-  if (getASTManager()->initCompilerInvocation(Invocation, Args, CI.getDiags(),
-                                             StringRef(), Error)) {
+  if (getASTManager()->initCompilerInvocation(
+          Invocation, Args, FrontendOptions::ActionType::Typecheck,
+          CI.getDiags(), StringRef(), Error)) {
     Consumer.handleRequestError(Error.c_str());
     return;
   }
@@ -674,8 +675,9 @@ void SwiftLangSupport::editorOpenInterface(EditorConsumer &Consumer,
 
   CompilerInvocation Invocation;
   std::string Error;
-  if (getASTManager()->initCompilerInvocationNoInputs(Invocation, Args,
-                                                     CI.getDiags(), Error)) {
+  if (getASTManager()->initCompilerInvocationNoInputs(
+          Invocation, Args, FrontendOptions::ActionType::Typecheck,
+          CI.getDiags(), Error)) {
     Consumer.handleRequestError(Error.c_str());
     return;
   }
@@ -740,7 +742,7 @@ void SwiftLangSupport::editorOpenSwiftSourceInterface(
     SourceKitCancellationToken CancellationToken,
     std::shared_ptr<EditorConsumer> Consumer) {
   std::string Error;
-  auto Invocation = ASTMgr->getInvocation(Args, SourceName, Error);
+  auto Invocation = ASTMgr->getTypecheckInvocation(Args, SourceName, Error);
   if (!Invocation) {
     Consumer->handleRequestError(Error.c_str());
     return;
@@ -769,8 +771,9 @@ void SwiftLangSupport::editorOpenHeaderInterface(EditorConsumer &Consumer,
   std::string Error;
 
   ArrayRef<const char *> SwiftArgs = UsingSwiftArgs ? Args : llvm::None;
-  if (getASTManager()->initCompilerInvocationNoInputs(Invocation, SwiftArgs,
-                                                     CI.getDiags(), Error)) {
+  if (getASTManager()->initCompilerInvocationNoInputs(
+          Invocation, SwiftArgs, FrontendOptions::ActionType::Typecheck,
+          CI.getDiags(), Error)) {
     Consumer.handleRequestError(Error.c_str());
     return;
   }
@@ -819,8 +822,9 @@ void SwiftLangSupport::findInterfaceDocument(StringRef ModuleName,
 
   CompilerInvocation Invocation;
   std::string Error;
-  if (getASTManager()->initCompilerInvocation(Invocation, Args, CI.getDiags(),
-                                             StringRef(), Error)) {
+  if (getASTManager()->initCompilerInvocation(
+          Invocation, Args, FrontendOptions::ActionType::Typecheck,
+          CI.getDiags(), StringRef(), Error)) {
     return Receiver(RequestResult<InterfaceDocInfo>::fromError(Error));
   }
 

tools/SourceKit/lib/SwiftLang/SwiftIndexing.cpp

@@ -303,10 +303,12 @@ void SwiftLangSupport::indexSource(StringRef InputFile,
   bool Failed = true;
   if (IsModuleIndexing) {
     Failed = getASTManager()->initCompilerInvocationNoInputs(
-        Invocation, Args, CI.getDiags(), Error);
+        Invocation, Args, FrontendOptions::ActionType::Typecheck, CI.getDiags(),
+        Error);
   } else {
     Failed = getASTManager()->initCompilerInvocation(
-        Invocation, Args, CI.getDiags(), InputFile, Error);
+        Invocation, Args, FrontendOptions::ActionType::Typecheck, CI.getDiags(),
+        InputFile, Error);
   }
   if (Failed) {
     IdxConsumer.failed(Error);

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.cpp

@@ -1043,8 +1043,8 @@ void SwiftLangSupport::performWithParamsToCompletionLikeOperation(
   CompilerInvocation Invocation;
   std::string CompilerInvocationError;
   bool CreatingInvocationFailed = getASTManager()->initCompilerInvocation(
-      Invocation, Args, Diags, newBuffer->getBufferIdentifier(), FileSystem,
-      CompilerInvocationError);
+      Invocation, Args, FrontendOptions::ActionType::Typecheck, Diags,
+      newBuffer->getBufferIdentifier(), FileSystem, CompilerInvocationError);
   if (CreatingInvocationFailed) {
     PerformOperation(CancellableResult<CompletionLikeOperationParams>::failure(
         CompilerInvocationError));