Merge pull request #39386 from rintaro/ide-completion-sourcefileinfo

[CodeCompletion] Revert "Provide known module source file information"

Author: rintaro

include/swift/IDE/CodeCompletion.h

@@ -686,7 +686,6 @@ class CodeCompletionResult {
 private:
   CodeCompletionString *CompletionString;
   StringRef ModuleName;
-  StringRef SourceFilePath;
   StringRef BriefDocComment;
   ArrayRef<StringRef> AssociatedUSRs;
   unsigned TypeDistance : 3;
@@ -797,7 +796,7 @@ class CodeCompletionResult {
                        CodeCompletionFlair Flair, unsigned NumBytesToErase,
                        CodeCompletionString *CompletionString,
                        CodeCompletionDeclKind DeclKind, bool IsSystem,
-                       StringRef ModuleName, StringRef SourceFilePath,
+                       StringRef ModuleName,
                        CodeCompletionResult::NotRecommendedReason NotRecReason,
                        CodeCompletionDiagnosticSeverity diagSeverity,
                        StringRef DiagnosticMessage, StringRef BriefDocComment,
@@ -806,10 +805,10 @@ class CodeCompletionResult {
                        CodeCompletionOperatorKind KnownOperatorKind)
       : Kind(ResultKind::Declaration),
         KnownOperatorKind(unsigned(KnownOperatorKind)),
-        SemanticContext(unsigned(SemanticContext)), Flair(unsigned(Flair.toRaw())),
-        NotRecommended(unsigned(NotRecReason)), IsSystem(IsSystem),
-        NumBytesToErase(NumBytesToErase), CompletionString(CompletionString),
-        ModuleName(ModuleName), SourceFilePath(SourceFilePath),
+        SemanticContext(unsigned(SemanticContext)),
+        Flair(unsigned(Flair.toRaw())), NotRecommended(unsigned(NotRecReason)),
+        IsSystem(IsSystem), NumBytesToErase(NumBytesToErase),
+        CompletionString(CompletionString), ModuleName(ModuleName),
         BriefDocComment(BriefDocComment), AssociatedUSRs(AssociatedUSRs),
         TypeDistance(TypeDistance), DiagnosticSeverity(unsigned(diagSeverity)),
         DiagnosticMessage(DiagnosticMessage) {
@@ -907,10 +906,6 @@ class CodeCompletionResult {
     return AssociatedUSRs;
   }
 
-  void setSourceFilePath(StringRef value) {
-    SourceFilePath = value;
-  }
-
   void setDiagnostics(CodeCompletionDiagnosticSeverity severity, StringRef message) {
     DiagnosticSeverity = static_cast<unsigned>(severity);
     DiagnosticMessage = message;
@@ -924,12 +919,6 @@ class CodeCompletionResult {
     return DiagnosticMessage;
   }
 
-  /// Returns the source file path where the associated decl was declared.
-  /// Returns an empty string if the information is not available.
-  StringRef getSourceFilePath() const {
-    return SourceFilePath;
-  }
-
   /// Print a debug representation of the code completion result to \p OS.
   void printPrefix(raw_ostream &OS) const;
   SWIFT_DEBUG_DUMP;
@@ -942,15 +931,6 @@ class CodeCompletionResult {
   static bool getDeclIsSystem(const Decl *D);
 };
 
-/// A pair of a file path and its up-to-date-ness.
-struct SourceFileAndUpToDate {
-  StringRef FilePath;
-  bool IsUpToDate;
-
-  SourceFileAndUpToDate(StringRef FilePath, bool IsUpToDate)
-      : FilePath(FilePath), IsUpToDate(IsUpToDate) {}
-};
-
 struct CodeCompletionResultSink {
   using AllocatorPtr = std::shared_ptr<llvm::BumpPtrAllocator>;
 
@@ -963,13 +943,11 @@ struct CodeCompletionResultSink {
 
   /// Whether to annotate the results with XML.
   bool annotateResult = false;
-  bool requiresSourceFileInfo = false;
 
   /// Whether to emit object literals if desired.
   bool includeObjectLiterals = true;
 
   std::vector<CodeCompletionResult *> Results;
-  std::vector<SourceFileAndUpToDate> SourceFiles;
 
   /// A single-element cache for module names stored in Allocator, keyed by a
   /// clang::Module * or swift::ModuleDecl *.
@@ -1040,9 +1018,6 @@ class CodeCompletionContext {
   void setAnnotateResult(bool flag) { CurrentResults.annotateResult = flag; }
   bool getAnnotateResult() const { return CurrentResults.annotateResult; }
 
-  void setRequiresSourceFileInfo(bool flag) { CurrentResults.requiresSourceFileInfo = flag; }
-  bool requiresSourceFileInfo() const { return CurrentResults.requiresSourceFileInfo; }
-
   void setIncludeObjectLiterals(bool flag) {
     CurrentResults.includeObjectLiterals = flag;
   }
@@ -1098,7 +1073,6 @@ class PrintingCodeCompletionConsumer
   bool IncludeComments;
   bool IncludeSourceText;
   bool PrintAnnotatedDescription;
-  bool RequiresSourceFileInfo = false;
 
 public:
  PrintingCodeCompletionConsumer(llvm::raw_ostream &OS,

include/swift/IDE/ModuleSourceFileInfo.h

@@ -12,7 +12,6 @@ add_swift_host_library(swiftIDE STATIC
   FuzzyStringMatcher.cpp
   Refactoring.cpp
   ModuleInterfacePrinting.cpp
-  ModuleSourceFileInfo.cpp
   REPLCodeCompletion.cpp
   SwiftSourceDocInfo.cpp
   SyntaxModel.cpp

lib/IDE/CMakeLists.txt

@@ -34,7 +34,6 @@
 #include "swift/Frontend/FrontendOptions.h"
 #include "swift/IDE/CodeCompletionCache.h"
 #include "swift/IDE/CodeCompletionResultPrinter.h"
-#include "swift/IDE/ModuleSourceFileInfo.h"
 #include "swift/IDE/Utils.h"
 #include "swift/Parse/CodeCompletionCallbacks.h"
 #include "swift/Sema/IDETypeChecking.h"
@@ -636,9 +635,9 @@ CodeCompletionResult::withFlair(CodeCompletionFlair newFlair,
     return new (*Sink.Allocator) CodeCompletionResult(
         getSemanticContext(), newFlair, getNumBytesToErase(),
         getCompletionString(), getAssociatedDeclKind(), isSystem(),
-        getModuleName(), getSourceFilePath(), getNotRecommendedReason(),
-        getDiagnosticSeverity(), getDiagnosticMessage(),
-        getBriefDocComment(), getAssociatedUSRs(), getExpectedTypeRelation(),
+        getModuleName(), getNotRecommendedReason(), getDiagnosticSeverity(),
+        getDiagnosticMessage(), getBriefDocComment(), getAssociatedUSRs(),
+        getExpectedTypeRelation(),
         isOperator() ? getOperatorKind() : CodeCompletionOperatorKind::None);
   } else {
     return new (*Sink.Allocator) CodeCompletionResult(
@@ -1303,8 +1302,6 @@ CodeCompletionResult *CodeCompletionResultBuilder::takeResult() {
         ModuleName, NotRecReason, copyString(*Sink.Allocator, BriefDocComment),
         copyAssociatedUSRs(*Sink.Allocator, AssociatedDecl),
         ExpectedTypeRelation);
-    if (!result->isSystem())
-      result->setSourceFilePath(getSourceFilePathForDecl(AssociatedDecl));
     if (NotRecReason != NotRecommendedReason::None) {
       // FIXME: We should generate the message lazily.
       if (const auto *VD = dyn_cast<ValueDecl>(AssociatedDecl)) {
@@ -6575,37 +6572,6 @@ static void postProcessResults(MutableArrayRef<CodeCompletionResult *> results,
   }
 }
 
-static void copyAllKnownSourceFileInfo(
-    ASTContext &Ctx, CodeCompletionResultSink &Sink) {
-  assert(Sink.SourceFiles.empty());
-
-  SmallVector<ModuleDecl *, 8> loadedModules;
-  loadedModules.reserve(Ctx.getNumLoadedModules());
-  for (auto &entry : Ctx.getLoadedModules())
-    loadedModules.push_back(entry.second);
-
-  auto &result = Sink.SourceFiles;
-  for (auto *M : loadedModules) {
-    // We don't need to check system modules.
-    if (M->isSystemModule())
-      continue;
-
-    M->collectBasicSourceFileInfo([&](const BasicSourceFileInfo &info) {
-      if (info.getFilePath().empty())
-        return;
-      
-      bool isUpToDate = false;
-      if (info.isFromSourceFile()) {
-        // 'SourceFile' is always "up-to-date" because we've just loaded.
-        isUpToDate = true;
-      } else {
-        isUpToDate = isSourceFileUpToDate(info, Ctx);
-      }
-      result.emplace_back(copyString(*Sink.Allocator, info.getFilePath()), isUpToDate);
-    });
-  }
-}
-
 static void deliverCompletionResults(CodeCompletionContext &CompletionContext,
                                      CompletionLookup &Lookup,
                                      DeclContext *DC,
@@ -6725,10 +6691,6 @@ static void deliverCompletionResults(CodeCompletionContext &CompletionContext,
                      CompletionContext.CodeCompletionKind, DC,
                      /*Sink=*/nullptr);
 
-  if (CompletionContext.requiresSourceFileInfo())
-    copyAllKnownSourceFileInfo(SF.getASTContext(),
-                               CompletionContext.getResultSink());
-
   Consumer.handleResultsAndModules(CompletionContext, RequestedModules, DC);
 }
 
@@ -7447,16 +7409,6 @@ void CodeCompletionCallbacksImpl::doneParsing() {
 
 void PrintingCodeCompletionConsumer::handleResults(
     CodeCompletionContext &context) {
-  if (context.requiresSourceFileInfo() &&
-      !context.getResultSink().SourceFiles.empty()) {
-    OS << "Known module source files\n";
-    for (auto &entry : context.getResultSink().SourceFiles) {
-      OS << (entry.IsUpToDate ? " + "  : " - ");
-      OS << entry.FilePath;
-      OS << "\n";
-    }
-    this->RequiresSourceFileInfo = true;
-  }
   auto results = context.takeResults();
   handleResults(results);
 }
@@ -7503,13 +7455,6 @@ void PrintingCodeCompletionConsumer::handleResults(
       OS << "; comment=" << comment;
     }
 
-    if (RequiresSourceFileInfo) {
-      StringRef sourceFilePath = Result->getSourceFilePath();
-      if (!sourceFilePath.empty()) {
-        OS << "; source=" << sourceFilePath;
-      }
-    }
-
     if (Result->getDiagnosticSeverity() !=
         CodeCompletionDiagnosticSeverity::None) {
       OS << "; diagnostics=" << comment;

lib/IDE/CodeCompletion.cpp

@@ -102,7 +102,7 @@ CodeCompletionCache::~CodeCompletionCache() {}
 ///
 /// This should be incremented any time we commit a change to the format of the
 /// cached results. This isn't expected to change very often.
-static constexpr uint32_t onDiskCompletionCacheVersion = 2;
+static constexpr uint32_t onDiskCompletionCacheVersion = 3; // Removed "source file path".
 
 /// Deserializes CodeCompletionResults from \p in and stores them in \p V.
 /// \see writeCacheModule.
@@ -209,7 +209,6 @@ static bool readCachedModule(llvm::MemoryBuffer *in,
     auto numBytesToErase = static_cast<unsigned>(*cursor++);
     auto chunkIndex = read32le(cursor);
     auto moduleIndex = read32le(cursor);
-    auto sourceFilePathIndex = read32le(cursor);
     auto briefDocIndex = read32le(cursor);
     auto diagMessageIndex = read32le(cursor);
 
@@ -221,15 +220,14 @@ static bool readCachedModule(llvm::MemoryBuffer *in,
 
     CodeCompletionString *string = getCompletionString(chunkIndex);
     auto moduleName = getString(moduleIndex);
-    auto sourceFilePath = getString(sourceFilePathIndex);
     auto briefDocComment = getString(briefDocIndex);
     auto diagMessage = getString(diagMessageIndex);
 
     CodeCompletionResult *result = nullptr;
     if (kind == CodeCompletionResult::Declaration) {
       result = new (*V.Sink.Allocator) CodeCompletionResult(
           context, CodeCompletionFlair(), numBytesToErase, string,
-          declKind, isSystem, moduleName, sourceFilePath, notRecommended,
+          declKind, isSystem, moduleName, notRecommended,
           diagSeverity, diagMessage, briefDocComment,
           copyArray(*V.Sink.Allocator, ArrayRef<StringRef>(assocUSRs)),
           CodeCompletionResult::Unknown, opKind);
@@ -369,7 +367,6 @@ static void writeCachedModule(llvm::raw_ostream &out,
       LE.write(
           static_cast<uint32_t>(addCompletionString(R->getCompletionString())));
       LE.write(addString(R->getModuleName()));      // index into strings
-      LE.write(addString(R->getSourceFilePath()));  // index into strings
       LE.write(addString(R->getBriefDocComment())); // index into strings
       LE.write(addString(R->getDiagnosticMessage())); // index into strings
 

lib/IDE/CodeCompletionCache.cpp

@@ -613,6 +613,10 @@ bool swift::ide::CompletionInstance::performOperation(
     std::string &Error, DiagnosticConsumer *DiagC,
     llvm::function_ref<void(CompilerInstance &, bool)> Callback) {
 
+  // Always disable source location resolutions from .swiftsourceinfo file
+  // because they're somewhat heavy operations and aren't needed for completion.
+  Invocation.getFrontendOptions().IgnoreSwiftSourceInfo = true;
+
   // Disable to build syntax tree because code-completion skips some portion of
   // source text. That breaks an invariant of syntax tree building.
   Invocation.getLangOptions().BuildSyntaxTree = false;