Add an interface mode getter/setter in PrintOptions and ModuleInterfaceOptions

Update args parsing

Author: elsh

include/swift/AST/PrintOptions.h

@@ -118,12 +118,6 @@ struct ShouldPrintChecker {
   virtual ~ShouldPrintChecker() = default;
 };
 
-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
-};
-
 /// Options for printing AST nodes.
 ///
 /// A default-constructed PrintOptions is suitable for printing to users;
@@ -189,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.
@@ -305,8 +318,6 @@ struct PrintOptions {
   /// Whether to skip keywords with a prefix of underscore such as __consuming.
   bool SkipUnderscoredKeywords = false;
 
-  InterfaceMode InterfaceContentMode;
-
   /// Prints type variables and unresolved types in an expanded notation suitable
   /// for debugging.
   bool PrintTypesForDebugging = false;
@@ -689,7 +700,7 @@ struct PrintOptions {
   static PrintOptions printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
                                               bool preferTypeRepr,
                                               bool printFullConvention,
-                                              InterfaceMode interfaceContentMode,
+                                              InterfaceMode interfaceMode,
                                               bool useExportedModuleNames,
                                               bool aliasModuleNames,
                                               llvm::SmallSet<StringRef, 4>

include/swift/Frontend/ModuleInterfaceSupport.h

@@ -55,9 +55,6 @@ struct ModuleInterfaceOptions {
   /// e.g. -package-name PACKAGE_ID
   std::string IgnorablePrivateFlags;
 
-  /// Prints package, SPIs, or public/inlinable decls depending on the mode.
-  InterfaceMode InterfaceContentMode = InterfaceMode::Public;
-
   /// 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;

lib/AST/ASTPrinter.cpp

@@ -174,7 +174,7 @@ static bool shouldTypeCheck(const PrintOptions &options) {
 PrintOptions PrintOptions::printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
                                                    bool preferTypeRepr,
                                                    bool printFullConvention,
-                                                   InterfaceMode interfaceContentMode,
+                                                   InterfaceMode interfaceMode,
                                                    bool useExportedModuleNames,
                                                    bool aliasModuleNames,
                                                    llvm::SmallSet<StringRef, 4>
@@ -206,7 +206,7 @@ PrintOptions PrintOptions::printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
     result.PrintFunctionRepresentationAttrs =
       PrintOptions::FunctionRepresentationMode::Full;
   result.AlwaysTryPrintParameterLabels = true;
-  result.InterfaceContentMode = interfaceContentMode;
+  result.InterfaceContentKind = interfaceMode;
   result.DesugarExistentialConstraint = true;
 
   // We should print __consuming, __owned, etc for the module interface file.
@@ -238,7 +238,7 @@ PrintOptions PrintOptions::printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
         return false;
 
       // Skip SPI decls if `PrintSPIs`.
-      if (options.InterfaceContentMode == InterfaceMode::Public && D->isSPI())
+      if (options.printPublicInterface() && D->isSPI())
         return false;
 
       if (auto *VD = dyn_cast<ValueDecl>(D)) {
@@ -252,7 +252,7 @@ PrintOptions PrintOptions::printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
             if (contributesToParentTypeStorage(ASD))
               return true;
 
-          if (options.InterfaceContentMode != InterfaceMode::Package || !isPackage(VD))
+          if (!options.printPackageInterface() || !isPackage(VD))
             return false;
         }
 
@@ -288,7 +288,7 @@ PrintOptions PrintOptions::printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
 
         for (const Requirement &req : ED->getGenericRequirements()) {
           if (!isPublicOrUsableFromInline(req.getFirstType())) {
-            if (options.InterfaceContentMode != InterfaceMode::Package || !isPackage(req.getSecondType()))
+            if (!options.printPackageInterface() || !isPackage(req.getSecondType()))
               return false;
           }
 
@@ -297,7 +297,7 @@ PrintOptions PrintOptions::printSwiftInterfaceFile(ModuleDecl *ModuleToPrint,
           case RequirementKind::Superclass:
           case RequirementKind::SameType:
             if (!isPublicOrUsableFromInline(req.getSecondType())) {
-              if (options.InterfaceContentMode != InterfaceMode::Package || !isPackage(req.getSecondType()))
+              if (!options.printPackageInterface() || !isPackage(req.getSecondType()))
                 return false;
             }
             break;
@@ -1205,7 +1205,7 @@ void PrintAST::printAttributes(const Decl *D) {
     }
 
     // Add SPIs to both private and package interfaces
-    if (Options.InterfaceContentMode != InterfaceMode::Public &&
+    if (!Options.printPublicInterface() &&
         DeclAttribute::canAttributeAppearOnDeclKind(
           DAK_SPIAccessControl, D->getKind())) {
       interleave(D->getSPIGroups(),
@@ -1294,7 +1294,7 @@ static bool mustPrintPropertyName(VarDecl *decl, const PrintOptions &opts) {
   if (contributesToParentTypeStorage(decl)) return true;
 
   // Print a package decl if in print package mode (for .package.swiftinterface),
-  if (opts.InterfaceContentMode == InterfaceMode::Package && isPackage(decl))
+  if (opts.printPackageInterface() && isPackage(decl))
     return true;
 
   // If it's public or @usableFromInline, we must print the name because it's a
@@ -6007,10 +6007,10 @@ class TypePrinter : public TypeVisitor<TypePrinter> {
     Filter |= ModuleDecl::ImportFilterKind::Default;
 
     // For private or package swiftinterfaces, also look through @_spiOnly imports.
-    if (Options.InterfaceContentMode != InterfaceMode::Public)
+    if (!Options.printPublicInterface())
       Filter |= ModuleDecl::ImportFilterKind::SPIOnly;
     // Consider package import for package interface
-    if (Options.InterfaceContentMode == InterfaceMode::Package)
+    if (Options.printPackageInterface())
       Filter |= ModuleDecl::ImportFilterKind::PackageOnly;
 
     SmallVector<ImportedModule, 4> Imports;

lib/AST/Attr.cpp

@@ -1048,7 +1048,7 @@ bool DeclAttribute::printImpl(ASTPrinter &Printer, const PrintOptions &Options,
     return true;
 
   case DAK_SPIAccessControl: {
-    if (Options.InterfaceContentMode == InterfaceMode::Public) return false;
+    if (Options.printPublicInterface()) return false;
 
     auto spiAttr = static_cast<const SPIAccessControlAttr*>(this);
     interleave(spiAttr->getSPIGroups(),
@@ -1100,7 +1100,7 @@ bool DeclAttribute::printImpl(ASTPrinter &Printer, const PrintOptions &Options,
     auto Attr = cast<AvailableAttr>(this);
     if (Options.SuppressNoAsyncAvailabilityAttr && Attr->isNoAsync())
       return false;
-    if (Options.InterfaceContentMode == InterfaceMode::Public && Attr->IsSPI) {
+    if (Options.printPublicInterface() && Attr->IsSPI) {
       assert(Attr->hasPlatform());
       assert(Attr->Introduced.has_value());
       Printer.printAttrName("@available");
@@ -1196,7 +1196,7 @@ bool DeclAttribute::printImpl(ASTPrinter &Printer, const PrintOptions &Options,
     auto *attr = cast<SpecializeAttr>(this);
     // Don't print the _specialize attribute if it is marked spi and we are
     // asked to skip SPI.
-    if (Options.InterfaceContentMode == InterfaceMode::Public && !attr->getSPIGroups().empty())
+    if (Options.printPublicInterface() && !attr->getSPIGroups().empty())
       return false;
 
     // Don't print the _specialize attribute if we are asked to skip the ones

lib/Frontend/CompilerInvocation.cpp

@@ -417,7 +417,7 @@ static void ParseModuleInterfaceArgs(ModuleInterfaceOptions &Opts,
   if (const Arg *A = Args.getLastArg(OPT_library_level)) {
     StringRef contents = A->getValue();
     if (contents == "spi") {
-      Opts.InterfaceContentMode = InterfaceMode::Private;
+      Opts.setInterfaceMode(PrintOptions::InterfaceMode::Private);
     }
   }
   for (auto val: Args.getAllArgValues(OPT_skip_import_in_public_interface)) {
@@ -622,11 +622,6 @@ static bool ParseLangArgs(LangOptions &Opts, ArgList &Args,
     Opts.EnableAccessControl
       = A->getOption().matches(OPT_enable_access_control);
   }
-  if (auto A = Args.getLastArg(OPT_experimental_package_interface_load,
-                               OPT_experimental_package_interface_load)) {
-    Opts.EnablePackageInterfaceLoad
-      = A->getOption().matches(OPT_experimental_package_interface_load);
-  }
 
   Opts.ForceWorkaroundBrokenModules
     |= Args.hasArg(OPT_force_workaround_broken_modules);
@@ -638,6 +633,10 @@ static bool ParseLangArgs(LangOptions &Opts, ArgList &Args,
     Opts.EnableExperimentalStringProcessing = true;
   }
 
+  if (Args.hasArg(OPT_experimental_package_interface_load)) {
+    Opts.EnablePackageInterfaceLoad = true;
+  }
+
   // Experimental string processing.
   if (auto A = Args.getLastArg(OPT_enable_experimental_string_processing,
                                OPT_disable_experimental_string_processing)) {

lib/Frontend/ModuleInterfaceSupport.cpp

@@ -71,9 +71,9 @@ static void printToolVersionAndFlagsComment(raw_ostream &out,
 
     ModuleDecl::ImportFilter filter = {ModuleDecl::ImportFilterKind::Default,
                                        ModuleDecl::ImportFilterKind::Exported};
-    if (Opts.InterfaceContentMode != InterfaceMode::Public)
+    if (!Opts.printPublicInterface())
       filter |= ModuleDecl::ImportFilterKind::SPIOnly;
-    if (Opts.InterfaceContentMode == InterfaceMode::Package)
+    if (Opts.printPackageInterface())
       filter |= ModuleDecl::ImportFilterKind::PackageOnly;
 
     SmallVector<ImportedModule> imports;
@@ -101,7 +101,7 @@ static void printToolVersionAndFlagsComment(raw_ostream &out,
         << Opts.IgnorableFlags << "\n";
   }
 
-  auto hasPrivateIgnorableFlags = Opts.InterfaceContentMode != InterfaceMode::Public && !Opts.IgnorablePrivateFlags.empty();
+  auto hasPrivateIgnorableFlags = !Opts.printPublicInterface() && !Opts.IgnorablePrivateFlags.empty();
   if (hasPrivateIgnorableFlags) {
     out << "// " SWIFT_MODULE_FLAGS_IGNORABLE_PRIVATE_KEY ": "
         << Opts.IgnorablePrivateFlags << "\n";
@@ -247,7 +247,7 @@ static void printImports(raw_ostream &out,
   // imports only if they are also SPI. First, list all implementation-only imports and
   // filter them later.
   llvm::SmallSet<ImportedModule, 4, ImportedModule::Order> ioiImportSet;
-  if (Opts.InterfaceContentMode != InterfaceMode::Public && Opts.ExperimentalSPIImports) {
+  if (!Opts.printPublicInterface() && Opts.ExperimentalSPIImports) {
 
     SmallVector<ImportedModule, 4> ioiImports, allImports;
     M->getImportedModules(ioiImports,
@@ -268,7 +268,7 @@ static void printImports(raw_ostream &out,
 
   /// Collect @_spiOnly imports that are not imported elsewhere publicly.
   llvm::SmallSet<ImportedModule, 4, ImportedModule::Order> spiOnlyImportSet;
-  if (Opts.InterfaceContentMode != InterfaceMode::Public) {
+  if (!Opts.printPublicInterface()) {
     SmallVector<ImportedModule, 4> spiOnlyImports, otherImports;
     M->getImportedModules(spiOnlyImports,
                           ModuleDecl::ImportFilterKind::SPIOnly);
@@ -335,7 +335,7 @@ static void printImports(raw_ostream &out,
     if (publicImportSet.count(import))
       out << "@_exported ";
 
-    if (Opts.InterfaceContentMode != InterfaceMode::Public) {
+    if (!Opts.printPublicInterface()) {
       // An import visible in the private or package swiftinterface only.
       //
       // In the long term, we want to print this attribute for consistency and
@@ -623,7 +623,7 @@ class InheritedProtocolCollector {
       return;
 
     // Skip SPI extensions in the public interface.
-    if (printOptions.InterfaceContentMode == InterfaceMode::Public && extension->isSPI())
+    if (printOptions.printPublicInterface() && extension->isSPI())
       return;
 
     const NominalTypeDecl *nominal = extension->getExtendedNominal();
@@ -704,7 +704,7 @@ class InheritedProtocolCollector {
             inherited->isSpecificProtocol(KnownProtocolKind::Actor))
           return TypeWalker::Action::SkipChildren;
 
-        if (inherited->isSPI() && printOptions.InterfaceContentMode == InterfaceMode::Public)
+        if (inherited->isSPI() && printOptions.printPublicInterface())
           return TypeWalker::Action::Continue;
 
         if (isPublicOrUsableFromInline(inherited) &&
@@ -784,7 +784,7 @@ class InheritedProtocolCollector {
       return false;
     assert(nominal->isGenericContext());
 
-    if (printOptions.InterfaceContentMode != InterfaceMode::Public)
+    if (!printOptions.printPublicInterface())
       out << "@_spi(" << DummyProtocolName << ")\n";
     out << "@available(*, unavailable)\nextension ";
     nominal->getDeclaredType().print(out, printOptions);
@@ -825,7 +825,7 @@ bool swift::emitSwiftInterface(raw_ostream &out,
 
   printImports(out, Opts, M, aliasModuleNamesTargets);
 
-  bool useExportedModuleNames = Opts.InterfaceContentMode == InterfaceMode::Public;
+  bool useExportedModuleNames = Opts.printPublicInterface();
 
   const PrintOptions printOptions = PrintOptions::printSwiftInterfaceFile(
       M, Opts.PreserveTypesAsWritten, Opts.PrintFullConvention,

lib/FrontendTool/FrontendTool.cpp

@@ -987,7 +987,7 @@ static bool emitAnyWholeModulePostTypeCheckSupplementaryOutputs(
   if (opts.InputsAndOutputs.hasPrivateModuleInterfaceOutputPath()) {
     // Copy the settings from the module interface to add SPI printing.
     ModuleInterfaceOptions privOpts = Invocation.getModuleInterfaceOptions();
-    privOpts.InterfaceContentMode = InterfaceMode::Private;
+    privOpts.setInterfaceMode(PrintOptions::InterfaceMode::Private);
     privOpts.ModulesToSkipInPublicInterface.clear();
 
     hadAnyError |= printModuleInterfaceIfNeeded(
@@ -1000,7 +1000,7 @@ static bool emitAnyWholeModulePostTypeCheckSupplementaryOutputs(
   if (opts.InputsAndOutputs.hasPackageModuleInterfaceOutputPath()) {
     // Copy the settings from the module interface to add package decl printing.
     ModuleInterfaceOptions pkgOpts = Invocation.getModuleInterfaceOptions();
-    pkgOpts.InterfaceContentMode = InterfaceMode::Package;
+    pkgOpts.setInterfaceMode(PrintOptions::InterfaceMode::Package);
     pkgOpts.ModulesToSkipInPublicInterface.clear();
 
     hadAnyError |= printModuleInterfaceIfNeeded(