remove private headers from public directory

Clean up the long standing issue with private headers being pushed into
the public headers directory.  Add a private modulemap so that we can
still access the private headers.

Author: compnerd

CoreFoundation/Base.subproj/SwiftRuntime/CoreFoundation.h

@@ -96,7 +96,5 @@
 #include <CoreFoundation/CFAttributedString.h>
 #include <CoreFoundation/CFNotificationCenter.h>
 
-#include <CoreFoundation/ForSwiftFoundationOnly.h>
-
 #endif /* ! __COREFOUNDATION_COREFOUNDATION__ */
 

CoreFoundation/Base.subproj/module.private.modulemap

@@ -0,0 +1,8 @@
+framework module CoreFoundation_Private [extern_c] [system] {
+  umbrella header "ForSwiftFoundationOnly.h"
+
+  export *
+  module * {
+    export *
+  }
+}

CoreFoundation/CMakeLists.txt

@@ -114,11 +114,13 @@ add_framework(CoreFoundation
                 CoreFoundation_FRAMEWORK_DIRECTORY
               MODULE_MAP
                 Base.subproj/module.modulemap
+                Base.subproj/module.private.modulemap
               PRIVATE_HEADERS
                 # Base
                 Base.subproj/CFAsmMacros.h
                 Base.subproj/CFInternal.h
                 Base.subproj/CFKnownLocations.h
+                Base.subproj/CFLocking.h
                 Base.subproj/CFLogUtilities.h
                 Base.subproj/CFPriv.h
                 Base.subproj/CFOverflow.h
@@ -182,29 +184,6 @@ add_framework(CoreFoundation
                 URL.subproj/CFURLPriv.h
                 URL.subproj/CFURLSessionInterface.h
               PUBLIC_HEADERS
-                # FIXME: PrivateHeaders referenced by public headers
-                Base.subproj/CFKnownLocations.h
-                Base.subproj/CFLocking.h
-                Base.subproj/CFLogUtilities.h
-                Base.subproj/CFPriv.h
-                Base.subproj/CFRuntime.h
-                Base.subproj/ForFoundationOnly.h
-                Base.subproj/ForSwiftFoundationOnly.h
-                Locale.subproj/CFCalendar_Internal.h
-                Locale.subproj/CFDateComponents.h
-                Locale.subproj/CFDateInterval.h
-                Locale.subproj/CFLocaleInternal.h
-                PlugIn.subproj/CFBundlePriv.h
-                Stream.subproj/CFStreamPriv.h
-                String.subproj/CFCharacterSetPriv.h
-                String.subproj/CFRegularExpression.h
-                String.subproj/CFRunArray.h
-                StringEncodings.subproj/CFStringEncodingConverter.h
-                StringEncodings.subproj/CFStringEncodingConverterExt.h
-                URL.subproj/CFURLPriv.h
-                URL.subproj/CFURLSessionInterface.h
-                Locale.subproj/CFDateIntervalFormatter.h
-
                 # AppServices
                 AppServices.subproj/CFNotificationCenter.h
                 AppServices.subproj/CFUserNotification.h

CoreFoundation/cmake/modules/CoreFoundationAddFramework.cmake

@@ -3,8 +3,8 @@ include(CMakeParseArguments)
 
 function(add_framework NAME)
   set(options STATIC SHARED)
-  set(single_value_args MODULE_MAP FRAMEWORK_DIRECTORY)
-  set(multiple_value_args PRIVATE_HEADERS PUBLIC_HEADERS SOURCES)
+  set(single_value_args FRAMEWORK_DIRECTORY)
+  set(multiple_value_args MODULE_MAP PRIVATE_HEADERS PUBLIC_HEADERS SOURCES)
   cmake_parse_arguments(AF "${options}" "${single_value_args}" "${multiple_value_args}" ${ARGN})
 
   set(AF_TYPE)
@@ -60,17 +60,9 @@ function(add_framework NAME)
                         PROPERTIES
                           LIBRARY_OUTPUT_DIRECTORY
                               ${CMAKE_BINARY_DIR}/${NAME}.framework)
-  if("${CMAKE_C_SIMULATE_ID}" STREQUAL "MSVC")
-    target_compile_options(${NAME}
-                           PRIVATE
-                             -Xclang;-F${CMAKE_BINARY_DIR})
-  else()
-    target_compile_options(${NAME}
-                           PRIVATE
-                             -F;${CMAKE_BINARY_DIR})
-  endif()
   target_compile_options(${NAME}
                          PRIVATE
+                           $<$<STREQUAL:${CMAKE_C_SIMULATE_ID},MSVC>:/clang:>-F;${CMAKE_BINARY_DIR}
                            $<$<OR:$<COMPILE_LANGUAGE:ASM>,$<COMPILE_LANGUAGE:C>>:-I;${CMAKE_BINARY_DIR}/${NAME}.framework/PrivateHeaders>)
   add_dependencies(${NAME} ${NAME}_POPULATE_HEADERS)
 

Foundation/Bundle.swift

@@ -9,6 +9,9 @@
 
 import CoreFoundation
 
+@_implementationOnly
+import CoreFoundation_Private
+
 @_silgen_name("swift_getTypeContextDescriptor")
 private func _getTypeContextDescriptor(of cls: AnyClass) -> UnsafeRawPointer
 

Foundation/CMakeLists.txt

@@ -138,6 +138,8 @@ add_library(Foundation
   UUID.swift)
 target_compile_definitions(Foundation PRIVATE
   DEPLOYMENT_RUNTIME_SWIFT)
+target_compile_options(Foundation PRIVATE
+  "SHELL:-Xcc -DDEPLOYMENT_RUNTIME_SWIFT")
 target_compile_options(Foundation PUBLIC
   "SHELL:-Xcc -F${CMAKE_BINARY_DIR}")
 target_compile_options(Foundation PRIVATE
@@ -212,6 +214,8 @@ add_library(FoundationNetworking
 target_compile_definitions(FoundationNetworking PRIVATE
   DEPLOYMENT_RUNTIME_SWIFT
   NS_BUILDING_FOUNDATION_NETWORKING)
+target_compile_options(FoundationNetworking PRIVATE
+  "SHELL:-Xcc -DDEPLOYMENT_RUNTIME_SWIFT")
 target_compile_options(FoundationNetworking PUBLIC
   "SHELL:-Xcc -F${CMAKE_BINARY_DIR}")
 if(ENABLE_TESTING)
@@ -238,6 +242,8 @@ add_library(FoundationXML
   XMLParser.swift)
 target_compile_definitions(FoundationXML PRIVATE
   DEPLOYMENT_RUNTIME_SWIFT)
+target_compile_options(FoundationXML PRIVATE
+  "SHELL:-Xcc -DDEPLOYMENT_RUNTIME_SWIFT")
 target_compile_options(FoundationXML PUBLIC
   "SHELL:-Xcc -F${CMAKE_BINARY_DIR}")
 if(ENABLE_TESTING)

Foundation/Data.swift

@@ -21,6 +21,13 @@ internal func malloc_good_size(_ size: Int) -> Int {
 
 import CoreFoundation
 
+@_implementationOnly
+import CoreFoundation_Private
+
+#if os(Windows)
+import WinSDK
+#endif
+
 internal func __NSDataInvokeDeallocatorUnmap(_ mem: UnsafeMutableRawPointer, _ length: Int) {
 #if os(Windows)
     UnmapViewOfFile(mem)
@@ -61,17 +68,10 @@ internal func __NSDataIsCompact(_ data: NSData) -> Bool {
 
 #endif
 
-#if os(Windows)
-@usableFromInline @discardableResult
-internal func __withStackOrHeapBuffer(_ size: Int, _ block: (UnsafeMutablePointer<_ConditionalAllocationBuffer>) -> Void) -> Bool {
+@discardableResult
+private func __withStackOrHeapBuffer(_ size: Int, _ block: (UnsafeMutablePointer<_ConditionalAllocationBuffer>) -> Void) -> Bool {
   return _withStackOrHeapBuffer(size, block)
 }
-#else
-@inlinable @inline(__always) @discardableResult
-internal func __withStackOrHeapBuffer(_ size: Int, _ block: (UnsafeMutablePointer<_ConditionalAllocationBuffer>) -> Void) -> Bool {
-  return _withStackOrHeapBuffer(size, block)
-}
-#endif
 
 // Underlying storage representation for medium and large data.
 // Inlinability strategy: methods from here should not inline into InlineSlice or LargeSlice unless trivial.
@@ -2083,7 +2083,6 @@ public struct Data : ReferenceConvertible, Equatable, Hashable, RandomAccessColl
     }
 
     // slightly faster paths for common sequences
-    @inlinable // This is @inlinable as an important generic funnel point, despite being a non-trivial initializer.
     public init<S: Sequence>(_ elements: S) where S.Element == UInt8 {
         // If the sequence is already contiguous, access the underlying raw memory directly.
         if let contiguous = elements as? ContiguousBytes {
@@ -2374,7 +2373,6 @@ public struct Data : ReferenceConvertible, Equatable, Hashable, RandomAccessColl
         }
     }
 
-    @inlinable // This is @inlinable as an important generic funnel point, despite being non-trivial.
     public mutating func append<S: Sequence>(contentsOf elements: S) where S.Element == Element {
         // If the sequence is already contiguous, access the underlying raw memory directly.
         if let contiguous = elements as? ContiguousBytes {
@@ -2474,7 +2472,6 @@ public struct Data : ReferenceConvertible, Equatable, Hashable, RandomAccessColl
     /// - precondition: The bounds of `subrange` must be valid indices of the collection.
     /// - parameter subrange: The range in the data to replace.
     /// - parameter newElements: The replacement bytes.
-    @inlinable // This is @inlinable as generic and reasonably small.
     public mutating func replaceSubrange<ByteCollection : Collection>(_ subrange: Range<Index>, with newElements: ByteCollection) where ByteCollection.Iterator.Element == Data.Iterator.Element {
         let totalCount = Int(newElements.count)
         __withStackOrHeapBuffer(totalCount) { conditionalBuffer in

Foundation/DateIntervalFormatter.swift

@@ -9,6 +9,9 @@
 
 import CoreFoundation
 
+@_implementationOnly
+import CoreFoundation_Private
+
 #if _runtime(_ObjC)
 internal let kCFDateIntervalFormatterNoStyle = CFDateIntervalFormatterStyle.noStyle
 internal let kCFDateIntervalFormatterShortStyle = CFDateIntervalFormatterStyle.shortStyle
@@ -85,15 +88,18 @@ internal extension _CFDateIntervalFormatterBoundaryStyle {
 // DateIntervalFormatter returns nil and NO for all methods in Formatter.
 
 open class DateIntervalFormatter: Formatter {
-    let core: CFDateIntervalFormatter
+    let _core: AnyObject
+    let core: CFDateIntervalFormatter {
+      unsafeBitCast(_core, to: CFDateIntervalFormatter.self)
+    }
 
     public override init() {
-        core = CFDateIntervalFormatterCreate(nil, nil, kCFDateIntervalFormatterShortStyle, kCFDateIntervalFormatterShortStyle)
+        _core = CFDateIntervalFormatterCreate(nil, nil, kCFDateIntervalFormatterShortStyle, kCFDateIntervalFormatterShortStyle)
         super.init()
     }
 
     private init(cfFormatter: CFDateIntervalFormatter) {
-        self.core = cfFormatter
+        self._core = cfFormatter
         super.init()
     }
 
@@ -120,7 +126,7 @@ open class DateIntervalFormatter: Formatter {
                                                           cfObject(of: NSLocale.self, from: coder, forKey: "NS.locale"),
                                                           cfObject(of: NSCalendar.self, from: coder, forKey: "NS.calendar"),
                                                           cfObject(of: NSTimeZone.self, from: coder, forKey: "NS.timeZone"))
-        self.core = core
+        self._core = core
 
         super.init(coder: coder)
     }

Foundation/FileHandle.swift

@@ -10,6 +10,13 @@
 import CoreFoundation
 import Dispatch
 
+#if os(Windows)
+import WinSDK
+#endif
+
+@_implementationOnly
+import CoreFoundation_Private
+
 // FileHandle has a .read(upToCount:) method. Just invoking read() will cause an ambiguity warning. Use _read instead.
 // Same with close()/.close().
 #if canImport(Darwin)

Foundation/FileManager+POSIX.swift

@@ -15,6 +15,9 @@ internal func &(left: UInt32, right: mode_t) -> mode_t {
 
 import CoreFoundation
 
+@_implementationOnly
+import CoreFoundation_Private
+
 extension FileManager {
     internal func _mountedVolumeURLs(includingResourceValuesForKeys propertyKeys: [URLResourceKey]?, options: VolumeEnumerationOptions = []) -> [URL]? {
         var urls: [URL] = []

Foundation/FileManager+Win32.swift

@@ -9,7 +9,12 @@
 
 import CoreFoundation
 
+@_implementationOnly
+import CoreFoundation_Private
+
 #if os(Windows)
+import WinSDK
+
 internal func joinPath(prefix: String, suffix: String) -> String {
     var pszPath: PWSTR?
     _ = prefix.withCString(encodedAs: UTF16.self) { prefix in

Foundation/FileManager.swift

@@ -16,10 +16,14 @@ fileprivate let UF_HIDDEN: Int32 = 1
 #endif
 
 import CoreFoundation
+
 #if os(Windows)
-import MSVCRT
+import WinSDK
 #endif
 
+@_implementationOnly
+import CoreFoundation_Private
+
 open class FileManager : NSObject {
 
     /* Returns the default singleton instance.

Foundation/FileManager_XDG.swift

@@ -9,6 +9,9 @@
 
 import CoreFoundation
 
+@_implementationOnly
+import CoreFoundation_Private
+
 enum _XDGUserDirectory: String {
     case desktop = "DESKTOP"
     case download = "DOWNLOAD"

Foundation/Host.swift

@@ -9,6 +9,10 @@
 
 import CoreFoundation
 
+#if os(Windows)
+import WinSDK
+#endif
+
 #if os(Android)
     // Android Glibc differs a little with respect to the Linux Glibc.
 

Foundation/NSArray.swift

@@ -9,6 +9,9 @@
 
 import CoreFoundation
 
+@_implementationOnly
+import CoreFoundation_Private
+
 open class NSArray : NSObject, NSCopying, NSMutableCopying, NSSecureCoding, NSCoding, ExpressibleByArrayLiteral {
     private let _cfinfo = _CFInfo(typeID: CFArrayGetTypeID())
     internal var _storage = [AnyObject]()

Foundation/NSAttributedString.swift

@@ -9,6 +9,9 @@
 
 import CoreFoundation
 
+@_implementationOnly
+import CoreFoundation_Private
+
 extension NSAttributedString {
     public struct Key: RawRepresentable, Equatable, Hashable {
         public let rawValue: String
@@ -50,7 +53,11 @@ open class NSAttributedString: NSObject, NSCopying, NSMutableCopying, NSSecureCo
 
     private let _cfinfo = _CFInfo(typeID: CFAttributedStringGetTypeID())
     fileprivate var _string: NSString
-    fileprivate var _attributeArray: CFRunArrayRef
+
+    fileprivate var __attributeArray: OpaquePointer
+    fileprivate var _attributeArray: CFRunArrayRef {
+      return unsafeBitCast(__attributeArray, to: CFRunArrayRef.self)
+    }
 
     public required init?(coder aDecoder: NSCoder) {
         let mutableAttributedString = NSMutableAttributedString(string: "")
@@ -60,7 +67,7 @@ open class NSAttributedString: NSObject, NSCopying, NSMutableCopying, NSSecureCo
 
         // use the resulting _string and _attributeArray to initialize a new instance, just like init
         _string = mutableAttributedString._string
-        _attributeArray = mutableAttributedString._attributeArray
+        __attributeArray = mutableAttributedString._attributeArray
     }
 
     open func encode(with aCoder: NSCoder) {
@@ -197,7 +204,7 @@ open class NSAttributedString: NSObject, NSCopying, NSMutableCopying, NSSecureCo
     /// Returns an NSAttributedString object initialized with the characters of a given string and no attribute information.
     public init(string: String) {
         _string = string._nsObject
-        _attributeArray = CFRunArrayCreate(kCFAllocatorDefault)
+        __attributeArray = CFRunArrayCreate(kCFAllocatorDefault)
 
         super.init()
         addAttributesToAttributeArray(attrs: nil)
@@ -206,7 +213,7 @@ open class NSAttributedString: NSObject, NSCopying, NSMutableCopying, NSSecureCo
     /// Returns an NSAttributedString object initialized with a given string and attributes.
     public init(string: String, attributes attrs: [NSAttributedString.Key: Any]? = nil) {
         _string = string._nsObject
-        _attributeArray = CFRunArrayCreate(kCFAllocatorDefault)
+        __attributeArray = CFRunArrayCreate(kCFAllocatorDefault)
 
         super.init()
         addAttributesToAttributeArray(attrs: attrs)
@@ -220,7 +227,7 @@ open class NSAttributedString: NSObject, NSCopying, NSMutableCopying, NSSecureCo
 
         // use the resulting _string and _attributeArray to initialize a new instance
         _string = mutableAttributedString._string
-        _attributeArray = mutableAttributedString._attributeArray
+        __attributeArray = mutableAttributedString._attributeArray
     }
 
     /// Executes the block for each attribute in the range.

Foundation/NSCFArray.swift

@@ -10,6 +10,9 @@
 
 import CoreFoundation
 
+@_implementationOnly
+import CoreFoundation_Private
+
 internal final class _NSCFArray : NSMutableArray {
     deinit {
         _CFDeinit(self)

Foundation/NSCFDictionary.swift

@@ -10,6 +10,9 @@
 
 import CoreFoundation
 
+@_implementationOnly
+import CoreFoundation_Private
+
 internal final class _NSCFDictionary : NSMutableDictionary {
     deinit {
         _CFDeinit(self)

Foundation/NSCFSet.swift

@@ -10,6 +10,9 @@
 
 import CoreFoundation
 
+@_implementationOnly
+import CoreFoundation_Private
+
 internal final class _NSCFSet : NSMutableSet {
     deinit {
         _CFDeinit(self)