Merge pull request #2231 from millenomi/bundle-for-anyclass

Parity: Bundle(for: AnyClass)

Author: millenomi

CoreFoundation/Base.subproj/ForSwiftFoundationOnly.h

@@ -414,6 +414,8 @@ CF_EXPORT _Nullable CFErrorRef CFWriteStreamCopyError(CFWriteStreamRef _Null_uns
 CF_CROSS_PLATFORM_EXPORT CFStringRef _Nullable _CFBundleCopyExecutablePath(CFBundleRef bundle);
 CF_CROSS_PLATFORM_EXPORT Boolean _CFBundleSupportsFHSBundles(void);
 CF_CROSS_PLATFORM_EXPORT Boolean _CFBundleSupportsFreestandingBundles(void);
+CF_CROSS_PLATFORM_EXPORT CFStringRef _Nullable _CFBundleCopyLoadedImagePathForAddress(const void *p);
+
 CF_CROSS_PLATFORM_EXPORT CFStringRef __CFTimeZoneCopyDataVersionString(void);
 
 CF_CROSS_PLATFORM_EXPORT void *_Nullable _CFURLCopyResourceInfo(CFURLRef url);

CoreFoundation/PlugIn.subproj/CFBundle_Binary.c

@@ -746,6 +746,11 @@ CF_PRIVATE void *_CFBundleDLLGetSymbolByName(CFBundleRef bundle, CFStringRef sym
 
 #endif /* BINARY_SUPPORT_DLL */
 
+// For Swift:
+CF_CROSS_PLATFORM_EXPORT CFStringRef _CFBundleCopyLoadedImagePathForAddress(const void *p) {
+    return _CFBundleCopyLoadedImagePathForPointer((void *)p);
+}
+
 CF_PRIVATE CFStringRef _CFBundleCopyLoadedImagePathForPointer(void *p) {
     CFStringRef imagePath = NULL;
 #if defined(BINARY_SUPPORT_DYLD)

Foundation/Bundle.swift

@@ -9,6 +9,9 @@
 
 import CoreFoundation
 
+@_silgen_name("swift_getTypeContextDescriptor")
+private func _getTypeContextDescriptor(of cls: AnyClass) -> UnsafeRawPointer
+
 open class Bundle: NSObject {
     private var _bundle : CFBundle!
 
@@ -100,9 +103,38 @@ open class Bundle: NSObject {
         self.init(path: url.path)
     }
 
+    #if os(Windows)
+    @available(Windows, deprecated, message: "Not yet implemented.")
     public init(for aClass: AnyClass) {
         NSUnimplemented()
     }
+    #else
+    public init(for aClass: AnyClass) {
+        let pointerInImageOfClass = _getTypeContextDescriptor(of: aClass)
+        guard let imagePath = _CFBundleCopyLoadedImagePathForAddress(pointerInImageOfClass)?._swiftObject else {
+            _bundle = CFBundleGetMainBundle()
+            return
+        }
+        
+        let path = (try? FileManager.default._canonicalizedPath(toFileAtPath: imagePath)) ?? imagePath
+        
+        let url = URL(fileURLWithPath: path)
+        if Bundle.main.executableURL == url {
+            _bundle = CFBundleGetMainBundle()
+            return
+        }
+        
+        for bundle in Bundle.allBundlesRegardlessOfType {
+            if bundle.executableURL == url {
+                _bundle = bundle._bundle
+                return
+            }
+        }
+        
+        let bundle = _CFBundleCreateWithExecutableURLIfMightBeBundle(kCFAllocatorSystemDefault, url._cfObject)?.takeRetainedValue()
+        _bundle = bundle ?? CFBundleGetMainBundle()
+    }
+    #endif
 
     public init?(identifier: String) {
         super.init()
@@ -388,5 +420,15 @@ open class Bundle: NSObject {
         let architectures = CFBundleCopyExecutableArchitectures(_bundle)!
         return architectures._swiftObject.map() { $0 as! NSNumber }
     }
+    
+    open override func isEqual(_ object: Any?) -> Bool {
+        guard let bundle = object as? Bundle else { return false }
+        return CFEqual(_bundle, bundle._bundle)
+    }
+    
+    open override var hash: Int {
+        return Int(bitPattern: CFHash(_bundle))
+    }
 }
 
+

TestFoundation/TestBundle.swift

@@ -338,31 +338,6 @@ class BundlePlayground {
 }
 
 class TestBundle : XCTestCase {
-    
-    static var allTests: [(String, (TestBundle) -> () throws -> Void)] {
-        var tests: [(String, (TestBundle) -> () throws -> Void)] = [
-            ("test_paths", test_paths),
-            ("test_resources", test_resources),
-            ("test_infoPlist", test_infoPlist),
-            ("test_localizations", test_localizations),
-            ("test_URLsForResourcesWithExtension", test_URLsForResourcesWithExtension),
-            ("test_bundleLoad", test_bundleLoad),
-            ("test_bundleLoadWithError", test_bundleLoadWithError),
-            ("test_bundleWithInvalidPath", test_bundleWithInvalidPath),
-            ("test_bundlePreflight", test_bundlePreflight),
-            ("test_bundleFindExecutable", test_bundleFindExecutable),
-            ("test_bundleFindAuxiliaryExecutables", test_bundleFindAuxiliaryExecutables),
-            ("test_bundleReverseBundleLookup", test_bundleReverseBundleLookup),
-        ]
-
-#if NS_FOUNDATION_ALLOWS_TESTABLE_IMPORT
-        tests.append(contentsOf: [
-            ("test_mainBundleExecutableURL", test_mainBundleExecutableURL),
-        ])
-#endif
-
-        return tests
-    }
 
     func test_paths() {
         let bundle = testBundle()
@@ -578,4 +553,34 @@ class TestBundle : XCTestCase {
 #endif
     }
 #endif
+    
+    func test_bundleForClass() {
+        XCTAssertEqual(testBundle(), Bundle(for: type(of: self)))
+    }
+    
+    static var allTests: [(String, (TestBundle) -> () throws -> Void)] {
+        var tests: [(String, (TestBundle) -> () throws -> Void)] = [
+            ("test_paths", test_paths),
+            ("test_resources", test_resources),
+            ("test_infoPlist", test_infoPlist),
+            ("test_localizations", test_localizations),
+            ("test_URLsForResourcesWithExtension", test_URLsForResourcesWithExtension),
+            ("test_bundleLoad", test_bundleLoad),
+            ("test_bundleLoadWithError", test_bundleLoadWithError),
+            ("test_bundleWithInvalidPath", test_bundleWithInvalidPath),
+            ("test_bundlePreflight", test_bundlePreflight),
+            ("test_bundleFindExecutable", test_bundleFindExecutable),
+            ("test_bundleFindAuxiliaryExecutables", test_bundleFindAuxiliaryExecutables),
+            ("test_bundleReverseBundleLookup", test_bundleReverseBundleLookup),
+            ("test_bundleForClass", testExpectedToFailOnWindows(test_bundleForClass, "Functionality not yet implemented on Windows. SR-XXXX")),
+        ]
+        
+        #if NS_FOUNDATION_ALLOWS_TESTABLE_IMPORT
+        tests.append(contentsOf: [
+            ("test_mainBundleExecutableURL", test_mainBundleExecutableURL),
+            ])
+        #endif
+        
+        return tests
+    }
 }

TestFoundation/Utilities.swift

@@ -498,14 +498,11 @@ func shouldAttemptXFailTests(_ reason: String) -> Bool {
 }
 
 func shouldAttemptWindowsXFailTests(_ reason: String) -> Bool {
-  var isOSWindows: Bool = false
-#if os(Windows)
-  isOSWindows = true
-#endif
-
-  if !isOSWindows || shouldRunXFailTests { return true }
-  try? FileHandle.standardError.write(contentsOf: Data("warning: Skipping test expected to fail with reason '\(reason)'\n".utf8))
-  return false
+    #if os(Windows)
+    return shouldAttemptXFailTests(reason)
+    #else
+    return true
+    #endif
 }
 
 func appendTestCaseExpectedToFail<T: XCTestCase>(_ reason: String, _ allTests: [(String, (T) -> () throws -> Void)], into array: inout [XCTestCaseEntry]) {
@@ -515,7 +512,15 @@ func appendTestCaseExpectedToFail<T: XCTestCase>(_ reason: String, _ allTests: [
 }
 
 func testExpectedToFail<T>(_ test:  @escaping (T) -> () throws -> Void, _ reason: String) -> (T) -> () throws -> Void {
-    if shouldAttemptXFailTests(reason) {
+    testExpectedToFailWithCheck(check: shouldAttemptXFailTests(_:), test, reason)
+}
+
+func testExpectedToFailOnWindows<T>(_ test:  @escaping (T) -> () throws -> Void, _ reason: String) -> (T) -> () throws -> Void {
+    testExpectedToFailWithCheck(check: shouldAttemptWindowsXFailTests(_:), test, reason)
+}
+
+func testExpectedToFailWithCheck<T>(check: (String) -> Bool, _ test:  @escaping (T) -> () throws -> Void, _ reason: String) -> (T) -> () throws -> Void {
+    if check(reason) {
         return test
     } else {
         return { _ in return { } }