- Introduce an option to print flags only for .private.swiftinterface

- Print package name flag only in private interface as package symbols are not exported
in public interface
- Allow all unicode characters in package-name input string

Resolves rdar://107638447, rdar://104617274

Author: elsh

include/swift/AST/DiagnosticsFrontend.def

@@ -189,9 +189,9 @@ ERROR(error_bad_export_as_name,none,
       "export-as name \"%0\" is not a valid identifier",
       (StringRef))
 
-ERROR(error_bad_package_name,none,
-      "package name \"%0\" is not a valid identifier",
-      (StringRef))
+ERROR(error_empty_package_name,none,
+      "package-name is empty; do not pass the flag if unused",
+      ())
 ERROR(error_stdlib_not_found,Fatal,
       "unable to load standard library for target '%0'", (StringRef))
 ERROR(error_module_alias_invalid_format,none,

include/swift/Frontend/ModuleInterfaceSupport.h

@@ -21,6 +21,7 @@
 #define SWIFT_COMPILER_VERSION_KEY "swift-compiler-version"
 #define SWIFT_MODULE_FLAGS_KEY "swift-module-flags"
 #define SWIFT_MODULE_FLAGS_IGNORABLE_KEY "swift-module-flags-ignorable"
+#define SWIFT_MODULE_FLAGS_IGNORABLE_PRIVATE_KEY "swift-module-flags-ignorable-private"
 
 namespace swift {
 
@@ -50,6 +51,10 @@ struct ModuleInterfaceOptions {
   /// ignored by the earlier version of the compiler.
   std::string IgnorableFlags;
 
+  /// Ignorable flags that should only be printed in .private.swiftinterface file;
+  /// e.g. -package-name PACKAGE_ID
+  std::string IgnorablePrivateFlags;
+
   /// Print for a private swiftinterface file, SPI decls and attributes.
   bool PrintPrivateInterfaceContent = false;
 

include/swift/Option/Options.h

@@ -42,6 +42,7 @@ namespace options {
     SwiftAPIDigesterOption = (1 << 17),
     NewDriverOnlyOption = (1 << 18),
     ModuleInterfaceOptionIgnorable = (1 << 19),
+    ModuleInterfaceOptionIgnorablePrivate = (1 << 20),
   };
 
   enum ID {

include/swift/Option/Options.td

@@ -56,6 +56,11 @@ 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 can be safely ignored by the older compiler.
+def ModuleInterfaceOptionIgnorablePrivate : OptionFlag;
+
 // The option causes the output of a supplementary output, or is the path option
 // for a supplementary output. E.g., `-emit-module` and `-emit-module-path`.
 def SupplementaryOutput : OptionFlag;
@@ -530,7 +535,7 @@ def module_abi_name : Separate<["-"], "module-abi-name">,
   Flags<[FrontendOption, ModuleInterfaceOption]>,
   HelpText<"ABI name to use for the contents of this module">;
 def package_name : Separate<["-"], "package-name">,
-  Flags<[FrontendOption, ModuleInterfaceOptionIgnorable]>,
+  Flags<[FrontendOption, ModuleInterfaceOptionIgnorablePrivate]>,
   HelpText<"Name of the package the module belongs to">;
 def export_as : Separate<["-"], "export-as">,
   Flags<[FrontendOption, ModuleInterfaceOptionIgnorable]>,

lib/Frontend/CompilerInvocation.cpp

@@ -401,8 +401,11 @@ static void SaveModuleInterfaceArgs(ModuleInterfaceOptions &Opts,
     return;
   ArgStringList RenderedArgs;
   ArgStringList RenderedArgsIgnorable;
+  ArgStringList RenderedArgsIgnorablePrivate;
   for (auto A : Args) {
-    if (A->getOption().hasFlag(options::ModuleInterfaceOptionIgnorable)) {
+    if (A->getOption().hasFlag(options::ModuleInterfaceOptionIgnorablePrivate)) {
+      A->render(Args, RenderedArgsIgnorablePrivate);
+    } else if (A->getOption().hasFlag(options::ModuleInterfaceOptionIgnorable)) {
       A->render(Args, RenderedArgsIgnorable);
     } else if (A->getOption().hasFlag(options::ModuleInterfaceOption)) {
       A->render(Args, RenderedArgs);
@@ -421,6 +424,12 @@ static void SaveModuleInterfaceArgs(ModuleInterfaceOptions &Opts,
     if (FOpts.ModuleName == "_Concurrency")
       OS << " -disable-availability-checking";
   }
+  {
+    llvm::raw_string_ostream OS(Opts.IgnorablePrivateFlags);
+    interleave(RenderedArgsIgnorablePrivate,
+               [&](const char *Argument) { PrintArg(OS, Argument, StringRef()); },
+               [&] { OS << " "; });
+  }
   {
     llvm::raw_string_ostream OS(Opts.IgnorableFlags);
     interleave(RenderedArgsIgnorable,
@@ -796,10 +805,11 @@ static bool ParseLangArgs(LangOptions &Opts, ArgList &Args,
 
   if (const Arg *A = Args.getLastArg(OPT_package_name)) {
     auto pkgName = A->getValue();
-    if (!Lexer::isIdentifier(pkgName))
-      Diags.diagnose(SourceLoc(), diag::error_bad_package_name, pkgName);
+    auto str = StringRef(pkgName);
+    if (str.empty())
+      Diags.diagnose(SourceLoc(), diag::error_empty_package_name);
     else
-      Opts.PackageName = pkgName;
+      Opts.PackageName = pkgName; //QuotedString(pkgName).getString();
   }
 
   if (const Arg *A = Args.getLastArg(OPT_require_explicit_availability_EQ)) {

lib/Frontend/Frontend.cpp

@@ -1155,8 +1155,8 @@ ModuleDecl *CompilerInstance::getMainModule() const {
           Invocation.getFrontendOptions().ModuleABIName));
     }
     if (!Invocation.getLangOptions().PackageName.empty()) {
-      MainModule->setPackageName(getASTContext().getIdentifier(
-          Invocation.getLangOptions().PackageName));
+      auto pkgName = Invocation.getLangOptions().PackageName;
+      MainModule->setPackageName(getASTContext().getIdentifier(pkgName));
     }
     if (!Invocation.getFrontendOptions().ExportAsName.empty()) {
       MainModule->setExportAsName(getASTContext().getIdentifier(

lib/Frontend/ModuleInterfaceSupport.cpp

@@ -98,6 +98,12 @@ static void printToolVersionAndFlagsComment(raw_ostream &out,
     out << "// " SWIFT_MODULE_FLAGS_IGNORABLE_KEY ": "
         << Opts.IgnorableFlags << "\n";
   }
+
+  auto hasPrivateIgnorableFlags = Opts.PrintPrivateInterfaceContent && !Opts.IgnorablePrivateFlags.empty();
+  if (hasPrivateIgnorableFlags) {
+    out << "// " SWIFT_MODULE_FLAGS_IGNORABLE_PRIVATE_KEY ": "
+        << Opts.IgnorablePrivateFlags << "\n";
+  }
 }
 
 std::string

test/Sema/accessibility_package_inline_interface.swift

@@ -10,7 +10,7 @@
 
 // RUN: %FileCheck %s -check-prefix CHECK-UTILS < %t/Utils.swiftinterface
 // CHECK-UTILS: -module-name Utils -enable-library-evolution
-// CHECK-UTILS: swift-module-flags-ignorable: -package-name myLib
+// CHECK-UTILS-NOT: -package-name myLib
 // CHECK-UTILS: @usableFromInline
 // CHECK-UTILS: package class PackageKlassProto {
 // CHECK-UTILS:   @usableFromInline

test/Sema/accessibility_package_interface.swift

@@ -0,0 +1,52 @@
+// RUN: %empty-directory(%t)
+// RUN: split-file %s %t
+
+// RUN: %target-swift-frontend -emit-module %t/Utils.swift \
+// RUN:   -module-name Utils -swift-version 5 -I %t \
+// RUN:   -package-name myLib
+// RUN:   -enable-library-evolution \
+// RUN:   -emit-module-path %t/Utils.swiftmodule \
+// RUN:   -emit-module-interface-path %t/Utils.swiftinterface \
+// RUN:   -emit-private-module-interface-path %t/Utils.private.swiftinterface
+
+// RUN: %target-swift-typecheck-module-from-interface(%t/Utils.swiftinterface) -I %t
+// RUN: %FileCheck %s --check-prefix=CHECK-PUBLIC < %t/Utils.swiftinterface
+// CHECK-PUBLIC: -module-name Utils -enable-library-evolution
+// CHECK-PUBLIC-NOT: -package-name myLib
+// CHECK-PUBLIC: public func publicFunc()
+// CHECK-PUBLIC-NOT: package func packageFunc()
+
+// RUN: %target-swift-typecheck-module-from-interface(%t/Utils.private.swiftinterface) -module-name Utils -I %t
+// RUN: %FileCheck %s --check-prefix=CHECK-PRIVATE < %t/Utils.private.swiftinterface
+
+// CHECK-PRIVATE: swift-module-flags-ignorable-private: -package-name myLib
+// CHECK-PRIVATE: public func publicFunc()
+// CHECK-PRIVATE: package func packageFunc()
+
+
+// RUN: %target-swift-frontend -emit-module %t/UtilsPkg.swift \
+// RUN:   -module-name UtilsPkg -swift-version 5 -I %t \
+// RUN:   -package-name "ab \\n cd"
+// RUN:   -enable-library-evolution \
+// RUN:   -emit-module-path %t/UtilsPkg.swiftmodule \
+// RUN:   -emit-module-interface-path %t/UtilsPkg.swiftinterface \
+// RUN:   -emit-private-module-interface-path %t/UtilsPkg.private.swiftinterface
+
+// RUN: %target-swift-typecheck-module-from-interface(%t/UtilsPkg.private.swiftinterface) -module-name Utils -I %t
+// RUN: %FileCheck %s --check-prefix=CHECK-PRIVATE-PKG < %t/UtilsPkg.private.swiftinterface
+// CHECK-PRIVATE-PKG: swift-module-flags-ignorable-private: -package-name "ab \n cd"
+
+// RUN: %target-swift-frontend -typecheck %t/Client.swift -package-nname "ab \\n cd" -verify
+
+
+//--- Utils.swift
+package func packageFunc() {}
+public func publicFunc() {}
+
+//--- Client.swift
+import UtilsPkg
+
+func clientFunc() {
+  packageFunc()
+  publicFunc()
+}

test/diagnostics/package-name-diagnostics.swift

@@ -1,14 +1,8 @@
 // RUN: %empty-directory(%t)
 
-// Package name should have valid characters
-// RUN: not %target-swift-frontend -module-name Logging -package-name My-Logging%Pkg %s -emit-module -emit-module-path %t/Logging.swiftmodule 2> %t/resultA.output
-// RUN: %FileCheck %s -input-file %t/resultA.output -check-prefix CHECK-BAD
-// CHECK-BAD: error: package name "My-Logging%Pkg" is not a valid identifier
-// CHECK-BAD: error: decl has a package access level but no -package-name was passed
-
 // Package name should not be empty
 // RUN: not %target-swift-frontend -typecheck %s -package-name "" 2>&1 | %FileCheck %s -check-prefix CHECK-EMPTY
-// CHECK-EMPTY: error: package name "" is not a valid identifier
+// CHECK-EMPTY: error: package-name is empty; do not pass the flag if unused
 // CHECK-EMPTY: error: decl has a package access level but no -package-name was passed
 
 // If package access level is used but no package-name is passed, it should error
@@ -23,5 +17,10 @@
 // RUN: %target-swift-frontend -module-name Logging -package-name Swift %s -emit-module -emit-module-path %t/Logging.swiftmodule
 // RUN: test -f %t/Logging.swiftmodule
 
+// Package name can have any unicode characters
+// RUN: %target-swift-frontend %s -typecheck -verify -package-name My-Logging%Pkg
+// RUN: %target-swift-frontend %s -typecheck -verify -package-name "a \\n b"
+// RUN: %target-swift-frontend %s -module-name Logging -package-name "a \bc \n \r de-f.g ~!@ #$ %^& *() -+ [] {} <> ,?/ | :" -emit-module -emit-module-path %t/Logging.swiftmodule -verify
+
 package func log() {}