CoreFoundation: 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

CMakeLists.txt

@@ -287,6 +287,7 @@ add_swift_library(Foundation
                   SWIFT_FLAGS
                     -Xcc -F${CMAKE_CURRENT_BINARY_DIR}
                     -DDEPLOYMENT_RUNTIME_SWIFT
+                    -Xcc -DDEPLOYMENT_RUNTIME_SWIFT
                     $<$<BOOL:FOUNDATION_ENABLE_LIBDISPATCH>:-DDEPLOYMENT_ENABLE_LIBDISPATCH>
                     -I;${ICU_INCLUDE_DIR}
                     ${libdispatch_cflags}
@@ -350,6 +351,7 @@ add_swift_library(FoundationNetworking
                     ${WORKAROUND_SR9995}
                   SWIFT_FLAGS
                     -DDEPLOYMENT_RUNTIME_SWIFT
+                    -Xcc -DDEPLOYMENT_RUNTIME_SWIFT
                     -DNS_BUILDING_FOUNDATION_NETWORKING
                     -Xcc -F${CMAKE_CURRENT_BINARY_DIR}
                     ${deployment_enable_libdispatch}
@@ -391,6 +393,7 @@ add_swift_executable(plutil
                      SWIFT_FLAGS
                        -Xcc -F${CMAKE_CURRENT_BINARY_DIR}
                        -DDEPLOYMENT_RUNTIME_SWIFT
+                       -Xcc -DDEPLOYMENT_RUNTIME_SWIFT
                        -I;${CMAKE_CURRENT_BINARY_DIR}/swift
                        -I;${ICU_INCLUDE_DIR}
                        ${libdispatch_cflags}
@@ -416,6 +419,7 @@ if(ENABLE_TESTING)
                          TestFoundation/xdgTestHelper/main.swift
                        SWIFT_FLAGS
                          -Xcc -F${CMAKE_CURRENT_BINARY_DIR}
+                         -Xcc -DDEPLOYMENT_RUNTIME_SWIFT
                          -I;${CMAKE_CURRENT_BINARY_DIR}/swift
                          -I;${ICU_INCLUDE_DIR}
                          ${libdispatch_cflags}
@@ -561,6 +565,7 @@ if(ENABLE_TESTING)
                          ${CMAKE_SOURCE_DIR}/TestFoundation/Fixtures
                        SWIFT_FLAGS
                          -Xcc -F${CMAKE_CURRENT_BINARY_DIR}
+                         -Xcc -DDEPLOYMENT_RUNTIME_SWIFT
                          -I;${CMAKE_CURRENT_BINARY_DIR}/swift
                          -I;${FOUNDATION_PATH_TO_XCTEST_BUILD}/swift
                          -I;${ICU_INCLUDE_DIR}

CoreFoundation/Base.subproj/CFLocking.h

@@ -37,16 +37,17 @@ static inline CFLock_t __CFLockInit(void) { return CFLockInit; }
 #elif TARGET_OS_WIN32
 
 #define NOMINMAX
+#define VC_EXTRALEAN
 #define WIN32_LEAN_AND_MEAN
-#define VCEXTRALEAN
 #include <Windows.h>
+#include <synchapi.h>
 
 typedef int32_t CFLock_t;
 #define CFLockInit 0
 #define CF_LOCK_INIT_FOR_STRUCTS(X) (X = CFLockInit)
 
 CF_INLINE void __CFLock(volatile CFLock_t *lock) {
-  while (InterlockedCompareExchange((LONG volatile *)lock, ~0, 0) != 0) {
+  while (InterlockedCompareExchange((long volatile *)lock, ~0, 0) != 0) {
     Sleep(0);
   }
 }
@@ -57,7 +58,7 @@ CF_INLINE void __CFUnlock(volatile CFLock_t *lock) {
 }
 
 CF_INLINE Boolean __CFLockTry(volatile CFLock_t *lock) {
-  return (InterlockedCompareExchange((LONG volatile *)lock, ~0, 0) == 0);
+  return (InterlockedCompareExchange((long volatile *)lock, ~0, 0) == 0);
 }
 
 // SPI to permit initialization of values in Swift
@@ -66,6 +67,7 @@ static inline CFLock_t __CFLockInit(void) { return CFLockInit; }
 #elif TARGET_OS_LINUX || TARGET_OS_BSD
 
 #include <stdint.h>
+#include <unistd.h>
 
 typedef int32_t CFLock_t;
 #define CFLockInit 0

CoreFoundation/Base.subproj/CFPriv.h

@@ -59,6 +59,8 @@ CF_EXPORT const char **_CFGetProcessPath(void);
 CF_EXPORT const char **_CFGetProgname(void);
 
 #if !TARGET_OS_WIN32
+#include <sys/types.h>
+
 CF_EXPORT void _CFGetUGIDs(uid_t *euid, gid_t *egid);
 CF_EXPORT uid_t _CFGetEUID(void);
 CF_EXPORT uid_t _CFGetEGID(void);
@@ -492,8 +494,8 @@ void CFCharacterSetInitInlineBuffer(CFCharacterSetRef cset, CFCharacterSetInline
  @result true, if the value is in the character set, otherwise false.
  */
 #if defined(CF_INLINE)
-CF_INLINE bool CFCharacterSetInlineBufferIsLongCharacterMember(const CFCharacterSetInlineBuffer *buffer, UTF32Char character) {
-    bool isInverted = ((0 == (buffer->flags & kCFCharacterSetIsInverted)) ? false : true);
+CF_INLINE Boolean CFCharacterSetInlineBufferIsLongCharacterMember(const CFCharacterSetInlineBuffer *buffer, UTF32Char character) {
+    Boolean isInverted = ((0 == (buffer->flags & kCFCharacterSetIsInverted)) ? FALSE : TRUE);
 
     if ((character >= buffer->rangeStart) && (character < buffer->rangeLimit)) {
         if ((character > 0xFFFF) || (0 != (buffer->flags & kCFCharacterSetNoBitmapAvailable))) return (CFCharacterSetIsLongCharacterMember(buffer->cset, character) != 0);
@@ -569,6 +571,7 @@ CF_EXPORT CFMessagePortRef _CFMessagePortCreateLocalEx(CFAllocatorRef allocator,
 #if _POSIX_THREADS
 #include <pthread.h>
 #endif
+#include <time.h>
 
 CF_INLINE CFAbsoluteTime _CFAbsoluteTimeFromFileTimeSpec(struct timespec ts) {
     return (CFAbsoluteTime)((CFTimeInterval)ts.tv_sec - kCFAbsoluteTimeIntervalSince1970) + (1.0e-9 * (CFTimeInterval)ts.tv_nsec);
@@ -592,10 +595,10 @@ CF_INLINE struct timespec _CFFileTimeSpecFromAbsoluteTime(CFAbsoluteTime at) {
 }
 
 // The 'filtered' function below is preferred to this older one
-CF_EXPORT bool _CFPropertyListCreateSingleValue(CFAllocatorRef allocator, CFDataRef data, CFOptionFlags option, CFStringRef keyPath, CFPropertyListRef *value, CFErrorRef *error);
+CF_EXPORT Boolean _CFPropertyListCreateSingleValue(CFAllocatorRef allocator, CFDataRef data, CFOptionFlags option, CFStringRef keyPath, CFPropertyListRef *value, CFErrorRef *error);
 
 // Returns a subset of the property list, only including the keyPaths in the CFSet. If the top level object is not a dictionary, you will get back an empty dictionary as the result.
-CF_EXPORT bool _CFPropertyListCreateFiltered(CFAllocatorRef allocator, CFDataRef data, CFOptionFlags option, CFSetRef keyPaths, CFPropertyListRef *value, CFErrorRef *error) API_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
+CF_EXPORT Boolean _CFPropertyListCreateFiltered(CFAllocatorRef allocator, CFDataRef data, CFOptionFlags option, CFSetRef keyPaths, CFPropertyListRef *value, CFErrorRef *error) API_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
 
 // Returns a set of the keys of the top-level dictionary of a plist. Optimized for bplist (though it works with XML too).  Only supports string keys. 
 CF_EXPORT CFSetRef _CFPropertyListCopyTopLevelKeys(CFAllocatorRef allocator, CFDataRef data, CFOptionFlags option, CFErrorRef *outError) API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));

CoreFoundation/Base.subproj/CoreFoundation.h

@@ -51,6 +51,7 @@
 #include <CoreFoundation/CFData.h>
 #include <CoreFoundation/CFDate.h>
 #include <CoreFoundation/CFDateFormatter.h>
+#include <CoreFoundation/CFDateIntervalFormatter.h>
 #include <CoreFoundation/CFDictionary.h>
 #include <CoreFoundation/CFError.h>
 #include <CoreFoundation/CFLocale.h>

CoreFoundation/Base.subproj/ForSwiftFoundationOnly.h

@@ -24,7 +24,6 @@
 #include <CoreFoundation/CFXMLInterface.h>
 #include <CoreFoundation/CFRegularExpression.h>
 #include <CoreFoundation/CFLogUtilities.h>
-#include <CoreFoundation/CFDateIntervalFormatter.h>
 #include <CoreFoundation/ForFoundationOnly.h>
 #include <CoreFoundation/CFCharacterSetPriv.h>
 #include <CoreFoundation/CFURLPriv.h>
@@ -77,6 +76,8 @@
 #endif //__GLIBC_PREREQ(2. 28)
 #endif // TARGET_OS_LINUX
 
+#include <stdlib.h>
+
 
 _CF_EXPORT_SCOPE_BEGIN
 
@@ -385,12 +386,12 @@ CF_EXPORT char *_Nullable *_Nonnull _CFEnviron(void);
 CF_EXPORT void CFLog1(CFLogLevel lev, CFStringRef message);
 
 #if TARGET_OS_WIN32
-typedef HANDLE _CFThreadRef;
+typedef void *_CFThreadRef;
 typedef struct _CFThreadAttributes {
-  DWORD dwSizeOfAttributes;
-  DWORD dwThreadStackReservation;
+  unsigned long dwSizeOfAttributes;
+  unsigned long dwThreadStackReservation;
 } _CFThreadAttributes;
-typedef DWORD _CFThreadSpecificKey;
+typedef unsigned long _CFThreadSpecificKey;
 #elif _POSIX_THREADS
 typedef pthread_t _CFThreadRef;
 typedef pthread_attr_t _CFThreadAttributes;

CoreFoundation/Base.subproj/SwiftRuntime/CoreFoundation.h

@@ -68,6 +68,7 @@
 #include <CoreFoundation/CFData.h>
 #include <CoreFoundation/CFDate.h>
 #include <CoreFoundation/CFDateFormatter.h>
+#include <CoreFoundation/CFDateIntervalFormatter.h>
 #include <CoreFoundation/CFDictionary.h>
 #include <CoreFoundation/CFError.h>
 #include <CoreFoundation/CFLocale.h>
@@ -96,7 +97,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

@@ -55,11 +55,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
@@ -124,30 +126,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
-                Parsing.subproj/CFXMLInterface.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/Locale.subproj/CFDateIntervalFormatter.h

@@ -71,8 +71,8 @@ CF_EXPORT void _CFDateIntervalFormatterInitializeFromCoderValues(CFDateIntervalF
                                                                  int64_t timeStyle,
                                                                  CFStringRef _Nullable dateTemplate,
                                                                  CFStringRef _Nullable dateTemplateFromStyles,
-                                                                 bool modified,
-                                                                 bool useTemplate,
+                                                                 Boolean modified,
+                                                                 Boolean useTemplate,
                                                                  CFLocaleRef _Nullable locale,
                                                                  CFCalendarRef _Nullable calendar,
                                                                  CFTimeZoneRef _Nullable timeZone);
@@ -82,8 +82,8 @@ CF_EXPORT void _CFDateIntervalFormatterCopyCoderValues(CFDateIntervalFormatterRe
                                                        int64_t *timeStyle,
                                                        CFStringRef _Nullable *_Nonnull dateTemplate,
                                                        CFStringRef _Nullable *_Nonnull dateTemplateFromStyles,
-                                                       bool *modified,
-                                                       bool *useTemplate,
+                                                       Boolean *modified,
+                                                       Boolean *useTemplate,
                                                        CFLocaleRef _Nullable *_Nonnull locale,
                                                        CFCalendarRef _Nullable *_Nonnull calendar,
                                                        CFTimeZoneRef _Nullable *_Nonnull timeZone);

CoreFoundation/Parsing.subproj/CFXMLInterface.h

@@ -141,7 +141,7 @@ typedef void* _CFXMLDTDPtr;
 typedef void* _CFXMLDTDNodePtr;
 
 _CFXMLNodePtr _CFXMLNewNode(_CFXMLNamespacePtr _Nullable name_space, const char* name);
-_CFXMLNodePtr _CFXMLCopyNode(_CFXMLNodePtr node, bool recursive);
+_CFXMLNodePtr _CFXMLCopyNode(_CFXMLNodePtr node, Boolean recursive);
 
 _CFXMLDocPtr _CFXMLNewDoc(const unsigned char* version);
 _CFXMLNodePtr _CFXMLNewProcessingInstruction(const unsigned char* name, const unsigned char* value);
@@ -175,8 +175,8 @@ void _CFXMLNodeReplaceNode(_CFXMLNodePtr node, _CFXMLNodePtr replacement);
 
 _CFXMLDocPtr _Nullable _CFXMLNodeGetDocument(_CFXMLNodePtr node);
 
-bool _CFXMLDocStandalone(_CFXMLDocPtr doc);
-void _CFXMLDocSetStandalone(_CFXMLDocPtr doc, bool standalone);
+Boolean _CFXMLDocStandalone(_CFXMLDocPtr doc);
+void _CFXMLDocSetStandalone(_CFXMLDocPtr doc, Boolean standalone);
 _CFXMLNodePtr _Nullable _CFXMLDocRootElement(_CFXMLDocPtr doc);
 void _CFXMLDocSetRootElement(_CFXMLDocPtr doc, _CFXMLNodePtr node);
 CFStringRef _Nullable _CFXMLDocCopyCharacterEncoding(_CFXMLDocPtr doc);
@@ -208,7 +208,7 @@ _CFXMLDocPtr _CFXMLDocPtrFromDataWithOptions(CFDataRef data, unsigned int option
 CFStringRef _Nullable _CFXMLNodeCopyLocalName(_CFXMLNodePtr node);
 CFStringRef _Nullable _CFXMLNodeCopyPrefix(_CFXMLNodePtr node);
 
-bool _CFXMLDocValidate(_CFXMLDocPtr doc, CFErrorRef _Nullable * error);
+Boolean _CFXMLDocValidate(_CFXMLDocPtr doc, CFErrorRef _Nullable * error);
 
 _CFXMLDTDPtr _CFXMLNewDTD(_CFXMLDocPtr _Nullable doc, const unsigned char* name, const unsigned char* publicID, const unsigned char* systemID);
 _CFXMLDTDNodePtr _Nullable _CFXMLParseDTDNode(const unsigned char* xmlString);

CoreFoundation/PlugIn.subproj/CFPlugInCOM.h

@@ -20,7 +20,12 @@ CF_EXTERN_C_BEGIN
 /* The _reserved field is part of the Microsoft COM binary standard on Macintosh. */
 /* You can declare new C struct interfaces by defining a new struct that includes "IUNKNOWN_C_GUTS;" before the first field of the struct. */
 
-#if !TARGET_OS_WIN32
+#if TARGET_OS_WIN32
+#define NOMINMAX
+#define VC_EXTRALEAN
+#define WIN32_LEAN_AND_MEAN
+#include <Windows.h>
+#else
 typedef SInt32 HRESULT;
 typedef UInt32 ULONG;
 typedef void *LPVOID;

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/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)

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

Foundation/FileHandle.swift

@@ -9,6 +9,12 @@
 
 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().

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