Serialization: Read and write support for public module name

Author: xymus

include/swift/AST/FileUnit.h

@@ -335,6 +335,12 @@ class FileUnit : public DeclContext, public ASTAllocated<FileUnit> {
     return getParentModule()->getRealName().str();
   }
 
+  /// Returns the public facing name of this module, only if it is set
+  /// explicitly.
+  virtual StringRef getPublicModuleName() const {
+    return {};
+  }
+
   SWIFT_DEBUG_DUMPER(dumpDisplayDecls());
   SWIFT_DEBUG_DUMPER(dumpTopLevelDecls());
 

include/swift/Serialization/SerializedModuleLoader.h

@@ -520,6 +520,8 @@ class SerializedASTFile final : public LoadedFile {
 
   virtual StringRef getExportedModuleName() const override;
 
+  virtual StringRef getPublicModuleName() const override;
+
   ValueDecl *getMainDecl() const override;
 
   bool hasEntryPoint() const override;

include/swift/Serialization/Validation.h

@@ -129,6 +129,7 @@ class ExtendedValidationInfo {
   StringRef ModuleABIName;
   StringRef ModulePackageName;
   StringRef ExportAsName;
+  StringRef PublicModuleName;
   CXXStdlibKind CXXStdlib;
   struct {
     unsigned ArePrivateImportsEnabled : 1;
@@ -230,6 +231,9 @@ class ExtendedValidationInfo {
   StringRef getModulePackageName() const { return ModulePackageName; }
   void setModulePackageName(StringRef name) { ModulePackageName = name; }
 
+  StringRef getPublicModuleName() const { return PublicModuleName; }
+  void setPublicModuleName(StringRef name) { PublicModuleName = name; }
+
   StringRef getExportAsName() const { return ExportAsName; }
   void setExportAsName(StringRef name) { ExportAsName = name; }
 

lib/Serialization/ModuleFile.cpp

@@ -1398,3 +1398,7 @@ StringRef SerializedASTFile::getExportedModuleName() const {
     return name;
   return FileUnit::getExportedModuleName();
 }
+
+StringRef SerializedASTFile::getPublicModuleName() const {
+  return File.getPublicModuleName();
+}

lib/Serialization/ModuleFile.h

@@ -587,6 +587,10 @@ class ModuleFile
     return Core->ModuleExportAsName;
   }
 
+  StringRef getPublicModuleName() const {
+    return Core->PublicModuleName;
+  }
+
   /// The ABI name of the module.
   StringRef getModuleABIName() const {
     return Core->ModuleABIName;

lib/Serialization/ModuleFileSharedCore.cpp

@@ -209,6 +209,9 @@ static bool readOptionsBlock(llvm::BitstreamCursor &cursor,
     case options_block::SERIALIZE_PACKAGE_ENABLED:
       extendedInfo.setSerializePackageEnabled(true);
       break;
+    case options_block::PUBLIC_MODULE_NAME:
+      extendedInfo.setPublicModuleName(blobData);
+      break;
     default:
       // Unknown options record, possibly for use by a future version of the
       // module format.
@@ -1474,6 +1477,7 @@ ModuleFileSharedCore::ModuleFileSharedCore(
       ModuleABIName = extInfo.getModuleABIName();
       ModulePackageName = extInfo.getModulePackageName();
       ModuleExportAsName = extInfo.getExportAsName();
+      PublicModuleName = extInfo.getPublicModuleName();
 
       hasValidControlBlock = true;
       break;

lib/Serialization/ModuleFileSharedCore.h

@@ -100,6 +100,9 @@ class ModuleFileSharedCore {
   /// Module name to use when referenced in clients module interfaces.
   StringRef ModuleExportAsName;
 
+  /// Name to use in public facing diagnostics and documentation.
+  StringRef PublicModuleName;
+
   /// \c true if this module has incremental dependency information.
   bool HasIncrementalInfo = false;
 

lib/Serialization/ModuleFormat.h

@@ -58,7 +58,7 @@ const uint16_t SWIFTMODULE_VERSION_MAJOR = 0;
 /// describe what change you made. The content of this comment isn't important;
 /// it just ensures a conflict if two people change the module format.
 /// Don't worry about adhering to the 80-column limit for this line.
-const uint16_t SWIFTMODULE_VERSION_MINOR = 887; // extravagant opened existentials
+const uint16_t SWIFTMODULE_VERSION_MINOR = 888; // public-module-name
 
 /// A standard hash seed used for all string hashes in a serialized module.
 ///
@@ -950,6 +950,7 @@ namespace options_block {
     ALLOW_NON_RESILIENT_ACCESS,
     SERIALIZE_PACKAGE_ENABLED,
     CXX_STDLIB_KIND,
+    PUBLIC_MODULE_NAME,
   };
 
   using SDKPathLayout = BCRecordLayout<
@@ -1045,6 +1046,11 @@ namespace options_block {
   using SerializePackageEnabled = BCRecordLayout<
     SERIALIZE_PACKAGE_ENABLED
   >;
+
+  using PublicModuleNameLayout = BCRecordLayout<
+    PUBLIC_MODULE_NAME,
+    BCBlob
+  >;
 }
 
 /// The record types within the input block.