Merge pull request #69733 from apple/es-pkg-intf

Introduce a package interface

Author: elsh

include/swift/AST/DiagnosticsSema.def

@@ -1107,9 +1107,9 @@ ERROR(module_not_testable,Fatal,
 ERROR(module_not_compiled_for_private_import,none,
       "module %0 was not compiled for private import", (Identifier))
 
-ERROR(in_package_module_not_compiled_from_source,none,
-      "module %0 is in package '%1' but was built from interface; "
-      "modules of the same package can only be loaded if built from source: %2",
+ERROR(in_package_module_not_compiled_from_source_or_package_interface,none,
+      "module %0 is in package '%1' but was built from a non-package interface; "
+      "modules of the same package can only be loaded if built from source or package interface: %2",
       (Identifier, StringRef, StringRef))
 
 WARNING(in_package_module_not_compiled_locally,none,

include/swift/AST/PrintOptions.h

@@ -183,6 +183,25 @@ struct PrintOptions {
   /// Whether to print enum raw value expressions.
   EnumRawValueMode EnumRawValues = EnumRawValueMode::Skip;
 
+  enum class InterfaceMode : uint8_t {
+    Public, // prints public/inlinable decls
+    Private, // prints SPI and public/inlinable decls
+    Package // prints package, SPI, and public/inlinable decls
+  };
+
+  InterfaceMode InterfaceContentKind;
+
+  bool printPublicInterface() const {
+    return InterfaceContentKind == InterfaceMode::Public;
+  }
+  bool printPackageInterface() const {
+    return InterfaceContentKind == InterfaceMode::Package;
+  }
+
+  void setInterfaceMode(InterfaceMode mode) {
+    InterfaceContentKind = mode;
+  }
+
   /// Whether to prefer printing TypeReprs instead of Types,
   /// if a TypeRepr is available.  This allows us to print the original
   /// spelling of the type name.
@@ -299,9 +318,6 @@ struct PrintOptions {
   /// Whether to skip keywords with a prefix of underscore such as __consuming.
   bool SkipUnderscoredKeywords = false;
 
-  // Print SPI attributes and decls that are visible only as SPI.
-  bool PrintSPIs = true;
-
   /// Prints type variables and unresolved types in an expanded notation suitable
   /// for debugging.
   bool PrintTypesForDebugging = false;
@@ -684,7 +700,7 @@ struct PrintOptions {
   static PrintOptions printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
                                               bool preferTypeRepr,
                                               bool printFullConvention,
-                                              bool printSPIs,
+                                              InterfaceMode interfaceMode,
                                               bool useExportedModuleNames,
                                               bool aliasModuleNames,
                                               llvm::SmallSet<StringRef, 4>

include/swift/Basic/FileTypes.def

@@ -51,6 +51,7 @@ TYPE("swiftmodule",         SwiftModuleFile,           "swiftmodule",     "")
 TYPE("swiftdoc",            SwiftModuleDocFile,        "swiftdoc",        "")
 TYPE("swiftinterface",      SwiftModuleInterfaceFile,  "swiftinterface",  "")
 TYPE("private-swiftinterface", PrivateSwiftModuleInterfaceFile,  "private.swiftinterface",  "")
+TYPE("package-swiftinterface", PackageSwiftModuleInterfaceFile,  "package.swiftinterface",  "")
 TYPE("swiftmodulesummary",  SwiftModuleSummaryFile,    "swiftmodulesummary", "")
 TYPE("swiftsourceinfo",     SwiftSourceInfoFile,       "swiftsourceinfo", "")
 TYPE("assembly",            Assembly,                  "s",               "")

include/swift/Basic/LangOptions.h

@@ -216,6 +216,10 @@ namespace swift {
     /// Should access control be respected?
     bool EnableAccessControl = true;
 
+    /// Enable loading a package interface if both client and depdency module are in the
+    /// same package determined by `package-name` flag.
+    bool EnablePackageInterfaceLoad = false;
+
     /// Enable 'availability' restrictions for App Extensions.
     bool EnableAppExtensionRestrictions = false;
 

include/swift/Basic/SupplementaryOutputPaths.def

@@ -137,6 +137,14 @@ OUTPUT(ModuleInterfaceOutputPath, TY_SwiftModuleInterfaceFile)
 OUTPUT(PrivateModuleInterfaceOutputPath,
             TY_PrivateSwiftModuleInterfaceFile)
 
+/// The path to which we should emit a package module interface.
+///
+/// The package interface contains package decls, SPIs, and public/inlinable decls.
+///
+/// \sa ModuleInterfaceOutputPath
+OUTPUT(PackageModuleInterfaceOutputPath,
+            TY_PackageSwiftModuleInterfaceFile)
+
 /// The path to which we should emit module summary file.
 OUTPUT(ModuleSummaryOutputPath, TY_SwiftModuleSummaryFile)
 

include/swift/Driver/Action.h

@@ -408,7 +408,8 @@ class VerifyModuleInterfaceJobAction : public JobAction {
     : JobAction(Action::Kind::VerifyModuleInterfaceJob, { ModuleEmitter },
                 file_types::TY_Nothing), inputType(inputType) {
     assert(inputType == file_types::TY_SwiftModuleInterfaceFile ||
-           inputType == file_types::TY_PrivateSwiftModuleInterfaceFile);
+           inputType == file_types::TY_PrivateSwiftModuleInterfaceFile ||
+           inputType == file_types::TY_PackageSwiftModuleInterfaceFile);
   }
 
   file_types::ID getInputType() const { return inputType; }

include/swift/Frontend/Frontend.h

@@ -432,6 +432,7 @@ class CompilerInvocation {
   /// fail an assert if not in that mode.
   std::string getModuleInterfaceOutputPathForWholeModule() const;
   std::string getPrivateModuleInterfaceOutputPathForWholeModule() const;
+  std::string getPackageModuleInterfaceOutputPathForWholeModule() const;
 
   /// APIDescriptorPath only makes sense in whole module compilation mode,
   /// so return the APIDescriptorPath when in that mode and fail an assert

include/swift/Frontend/FrontendInputsAndOutputs.h

@@ -266,6 +266,7 @@ class FrontendInputsAndOutputs {
   bool hasModuleSourceInfoOutputPath() const;
   bool hasModuleInterfaceOutputPath() const;
   bool hasPrivateModuleInterfaceOutputPath() const;
+  bool hasPackageModuleInterfaceOutputPath() const;
   bool hasABIDescriptorOutputPath() const;
   bool hasAPIDescriptorOutputPath() const;
   bool hasConstValuesOutputPath() const;

include/swift/Frontend/ModuleInterfaceSupport.h

@@ -55,9 +55,6 @@ struct ModuleInterfaceOptions {
   /// e.g. -package-name PACKAGE_ID
   std::string IgnorablePrivateFlags;
 
-  /// Print for a private swiftinterface file, SPI decls and attributes.
-  bool PrintPrivateInterfaceContent = false;
-
   /// Print imports with both @_implementationOnly and @_spi, only applies
   /// when PrintSPIs is true.
   bool ExperimentalSPIImports = false;
@@ -70,6 +67,18 @@ struct ModuleInterfaceOptions {
 
   /// A list of modules we shouldn't import in the public interfaces.
   std::vector<std::string> ModulesToSkipInPublicInterface;
+
+  /// A mode which decides whether the printed interface contains package, SPIs, or public/inlinable declarations.
+  PrintOptions::InterfaceMode InterfaceContentMode = PrintOptions::InterfaceMode::Public;
+  bool printPublicInterface() const {
+    return InterfaceContentMode == PrintOptions::InterfaceMode::Public;
+  }
+  bool printPackageInterface() const {
+    return InterfaceContentMode == PrintOptions::InterfaceMode::Package;
+  }
+  void setInterfaceMode(PrintOptions::InterfaceMode mode) {
+    InterfaceContentMode = mode;
+  }
 };
 
 extern version::Version InterfaceFormatVersion;

include/swift/Option/Options.td

@@ -56,8 +56,9 @@ def ModuleInterfaceOption : OptionFlag;
 // The option can be safely ignored by the older compiler.
 def ModuleInterfaceOptionIgnorable : OptionFlag;
 
-// The option should be written into a .private.swiftinterface module interface file,
-// and read/parsed from there when reconstituting a .swiftmodule from it.
+// The option should be written into a .private.swiftinterface or
+// .package.swiftinterface module interface file, and read/parsed from
+// there when reconstituting a .swiftmodule from it.
 // The option can be safely ignored by the older compiler.
 def ModuleInterfaceOptionIgnorablePrivate : OptionFlag;
 
@@ -593,6 +594,12 @@ def emit_private_module_interface_path :
          ArgumentIsPath, SupplementaryOutput, CacheInvariant]>,
   MetaVarName<"<path>">, HelpText<"Output private module interface file to <path>">;
 
+def emit_package_module_interface_path :
+  Separate<["-"], "emit-package-module-interface-path">,
+  Flags<[FrontendOption, NoInteractiveOption, HelpHidden,
+         ArgumentIsPath, SupplementaryOutput, CacheInvariant]>,
+  MetaVarName<"<path>">, HelpText<"Output package module interface file to <path>">;
+
 def verify_emitted_module_interface :
   Flag<["-"], "verify-emitted-module-interface">,
   Flags<[NoInteractiveOption, DoesNotAffectIncrementalBuild]>,
@@ -751,6 +758,11 @@ def experimental_hermetic_seal_at_link:
   Flags<[FrontendOption, HelpHidden]>,
   HelpText<"Library code can assume that all clients are visible at linktime, and aggressively strip unused code">;
 
+def experimental_package_interface_load:
+  Flag<["-"], "experimental-package-interface-load">,
+  Flags<[FrontendOption, HelpHidden]>,
+  HelpText<"Enables loading a package interface if in the same package specified with package-name">;
+
 // Diagnostic control options
 def suppress_warnings : Flag<["-"], "suppress-warnings">,
   Flags<[FrontendOption]>,