Restructure getDisplayDecl() Sendable forcing

Move this into a helper function that lives in Sema, avoiding libswiftAST calling into libswiftSema.

Author: beccadax

include/swift/AST/Module.h

@@ -758,7 +758,9 @@ class ModuleDecl
   /// The order of the results is not guaranteed to be meaningful.
   ///
   /// This can differ from \c getTopLevelDecls, e.g. it returns decls from a
-  /// shadowed clang module.
+  /// shadowed clang module. It does not force synthesized top-level decls that
+  /// should be printed to be added; use \c swift::getTopLevelDeclsForDisplay()
+  /// for that.
   void getDisplayDecls(SmallVectorImpl<Decl*> &results) const;
 
   using LinkLibraryCallback = llvm::function_ref<void(LinkLibrary)>;

include/swift/Sema/IDETypeChecking.h

@@ -140,6 +140,13 @@ namespace swift {
   LookupResult
   lookupSemanticMember(DeclContext *DC, Type ty, DeclName name);
 
+  /// Get all of the top-level declarations that should be printed as part of
+  /// this module. This may force synthesis of top-level declarations that
+  /// \c ModuleDecl::getDisplayDecls() would only return if previous
+  /// work happened to have synthesized them.
+  void
+  getTopLevelDeclsForDisplay(ModuleDecl *M, SmallVectorImpl<Decl*> &Results);
+
   struct ExtensionInfo {
     // The extension with the declarations to apply.
     ExtensionDecl *Ext;

lib/APIDigester/ModuleAnalyzerNodes.cpp

@@ -1,7 +1,8 @@
 #include "llvm/ADT/STLExtras.h"
+#include "swift/AST/ASTMangler.h"
 #include "swift/Basic/Defer.h"
+#include "swift/Sema/IDETypeChecking.h"
 #include "swift/SIL/SILDeclRef.h"
-#include "swift/AST/ASTMangler.h"
 #include <swift/APIDigester/ModuleAnalyzerNodes.h>
 #include <algorithm>
 
@@ -1872,7 +1873,7 @@ void SwiftDeclCollector::printTopLevelNames() {
 void SwiftDeclCollector::lookupVisibleDecls(ArrayRef<ModuleDecl *> Modules) {
   for (auto M: Modules) {
     llvm::SmallVector<Decl*, 512> Decls;
-    M->getDisplayDecls(Decls);
+    swift::getTopLevelDeclsForDisplay(M, Decls);
     for (auto D : Decls) {
       if (Ctx.shouldIgnore(D))
         continue;

lib/AST/Module.cpp

@@ -909,28 +909,6 @@ SourceFile::getExternalRawLocsForDecl(const Decl *D) const {
 void ModuleDecl::getDisplayDecls(SmallVectorImpl<Decl*> &Results) const {
   // FIXME: Should this do extra access control filtering?
   FORWARD(getDisplayDecls, (Results));
-
-  // Force Sendable on all types, which might synthesize some extensions.
-  // FIXME: We can remove this if @_nonSendable stops creating extensions.
-  for (auto result : Results) {
-    if (auto NTD = dyn_cast<NominalTypeDecl>(result))
-      (void)swift::isSendableType(const_cast<ModuleDecl *>(this),
-                                  NTD->getDeclaredInterfaceType());
-  }
-
-  // Re-add anything from synthesized file units...
-  auto oldCutoff = Results.size();
-  for (auto file : getFiles())
-    if (auto synthFile = dyn_cast<SynthesizedFileUnit>(file))
-      synthFile->getDisplayDecls(Results);
-
-  // And then remove anything that was already in the results.
-  auto oldResults = makeArrayRef(Results).take_front(oldCutoff);
-  auto uniqueEnd = std::remove_if(Results.begin() + oldCutoff, Results.end(),
-                                   [&](auto result) {
-    return llvm::is_contained(oldResults, result);
-  });
-  Results.erase(uniqueEnd, Results.end());
 }
 
 ProtocolConformanceRef

lib/FrontendTool/ImportedModules.cpp

@@ -59,6 +59,8 @@ bool swift::emitImportedModules(ModuleDecl *mainModule,
   llvm::SetVector<StringRef> Modules;
 
   // Find the imports in the main Swift code.
+  // We don't need `getTopLevelDeclsForDisplay()` here because we only care
+  // about `ImportDecl`s.
   llvm::SmallVector<Decl *, 32> Decls;
   mainModule->getDisplayDecls(Decls);
   for (auto D : Decls) {

lib/IDE/IDETypeChecking.cpp

@@ -33,6 +33,25 @@
 
 using namespace swift;
 
+void
+swift::getTopLevelDeclsForDisplay(ModuleDecl *M,
+                                  SmallVectorImpl<Decl*> &Results) {
+  auto startingSize = Results.size();
+  M->getDisplayDecls(Results);
+
+  // Force Sendable on all types, which might synthesize some extensions.
+  // FIXME: We can remove this if @_nonSendable stops creating extensions.
+  for (auto result : Results) {
+    if (auto NTD = dyn_cast<NominalTypeDecl>(result))
+      (void)swift::isSendableType(M, NTD->getDeclaredInterfaceType());
+  }
+
+  // Remove what we fetched and fetch again, possibly now with additional
+  // extensions.
+  Results.resize(startingSize);
+  M->getDisplayDecls(Results);
+}
+
 static bool shouldPrintAsFavorable(const Decl *D, const PrintOptions &Options) {
   if (!Options.TransformContext ||
       !isa<ExtensionDecl>(D->getDeclContext()) ||

lib/IDE/ModuleInterfacePrinting.cpp

@@ -399,12 +399,12 @@ static std::pair<ArrayRef<Decl*>, ArrayRef<Decl*>>
 getDeclsFromCrossImportOverlay(ModuleDecl *Overlay, ModuleDecl *Declaring,
                                SmallVectorImpl<Decl *> &Decls,
                                AccessLevel AccessFilter) {
-  Overlay->getDisplayDecls(Decls);
+  swift::getTopLevelDeclsForDisplay(Overlay, Decls);
 
   // Collect the imports of the underlying module so we can filter them out.
   SmallPtrSet<ModuleDecl *, 8> PrevImported;
   SmallVector<Decl*, 1> DeclaringDecls;
-  Declaring->getDisplayDecls(DeclaringDecls);
+  swift::getTopLevelDeclsForDisplay(Declaring, DeclaringDecls);
   for (auto *D: DeclaringDecls) {
     if (auto *ID = dyn_cast<ImportDecl>(D))
       PrevImported.insert(ID->getModule());
@@ -548,7 +548,7 @@ void swift::ide::printModuleInterface(
   adjustPrintOptions(AdjustedOptions);
 
   SmallVector<Decl *, 1> Decls;
-  TopLevelMod->getDisplayDecls(Decls);
+  swift::getTopLevelDeclsForDisplay(TopLevelMod, Decls);
 
   SmallVector<ImportDecl *, 1> ImportDecls;
   llvm::DenseSet<const clang::Module *> ClangModulesForImports;

lib/SymbolGraphGen/SymbolGraphGen.cpp

@@ -14,6 +14,7 @@
 #include "llvm/Support/Path.h"
 #include "swift/AST/ASTContext.h"
 #include "swift/AST/FileSystem.h"
+#include "swift/Sema/IDETypeChecking.h"
 #include "swift/SymbolGraphGen/SymbolGraphGen.h"
 
 #include "SymbolGraphASTWalker.h"
@@ -56,7 +57,7 @@ symbolgraphgen::emitSymbolGraphForModule(ModuleDecl *M,
                                          const SymbolGraphOptions &Options) {
   SymbolGraphASTWalker Walker(*M, Options);
   SmallVector<Decl *, 64> ModuleDecls;
-  M->getDisplayDecls(ModuleDecls);
+  swift::getTopLevelDeclsForDisplay(M, ModuleDecls);
 
   if (Options.PrintMessages)
     llvm::errs() << ModuleDecls.size()

tools/swift-dependency-tool/CMakeLists.txt

@@ -6,6 +6,5 @@ target_link_libraries(swift-dependency-tool
                       PRIVATE
                         swiftAST
                         swiftParse
-                        swiftClangImporter
-                        swiftSema)
+                        swiftClangImporter)
 

tools/swift-ide-test/ModuleAPIDiff.cpp

@@ -18,6 +18,7 @@
 #include "swift/Driver/FrontendUtil.h"
 #include "swift/Frontend/Frontend.h"
 #include "swift/Frontend/PrintingDiagnosticConsumer.h"
+#include "swift/Sema/IDETypeChecking.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/Support/YAMLTraits.h"
@@ -877,7 +878,7 @@ class SMAModelGenerator : public DeclVisitor<SMAModelGenerator> {
 
 std::shared_ptr<sma::Module> createSMAModel(ModuleDecl *M) {
   SmallVector<Decl *, 1> Decls;
-  M->getDisplayDecls(Decls);
+  swift::getTopLevelDeclsForDisplay(M, Decls);
 
   SMAModelGenerator Generator;
   for (auto *D : Decls) {

tools/swift-ide-test/swift-ide-test.cpp

@@ -2793,7 +2793,7 @@ static int doPrintModuleGroups(const CompilerInvocation &InitInvok,
     {
       GroupNamesPrinter Printer(llvm::outs());
       llvm::SmallVector<Decl*, 256> Results;
-      M->getDisplayDecls(Results);
+      swift::getTopLevelDeclsForDisplay(M, Results);
       for (auto R : Results) {
         Printer.addDecl(R);
       }