[PropertyListSerialization] Possible implementation of `propertyList(…

…with:options:format:)` Currently toll-free bridging between InputStream and CFReadStream is not implemented, so `InputStream._stream` is exposed and used instead.
jsubida · Jan 16, 2017 · 5d1bdb5 · 5d1bdb5
1 parent d83cbfd
commit 5d1bdb5
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 15 deletions.
diff --git a/Docs/Status.md b/Docs/Status.md
@@ -128,7 +128,7 @@ There is no _Complete_ status for test coverage because there are always additio
     | `NSKeyedUnarchiver`         | Mostly Complete | Substantial   | `decodingFailurePolicy.set` remains unimplemented                             |
     | `NSKeyedArchiverHelpers`    | N/A             | N/A           | For internal use only                                                         |
     | `NSCoder`                   | Incomplete      | N/A           | Decoding methods which require a concrete implementation remain unimplemented |
-    | `PropertyListSerialization` | Mostly Complete | Incomplete    | `propertyList(with:options:format:)` remains unimplemented                    |
+    | `PropertyListSerialization` | Complete        | Incomplete    |                                                                               |
 
 * **XML**: A group of classes for parsing and representing XML documents and elements.
 

diff --git a/Foundation/NSKeyedUnarchiver.swift b/Foundation/NSKeyedUnarchiver.swift
@@ -38,7 +38,7 @@ open class NSKeyedUnarchiver : NSCoder {
 
     private enum Stream {
         case data(Data)
-        case stream(InputStream)
+        case stream(CFReadStream)
     }
 
     private var _stream : Stream
@@ -74,7 +74,7 @@ open class NSKeyedUnarchiver : NSCoder {
             return nil
         }
 
-        let keyedUnarchiver = NSKeyedUnarchiver(stream: Stream.stream(unsafeBitCast(readStream, to: InputStream.self)))
+        let keyedUnarchiver = NSKeyedUnarchiver(stream: Stream.stream(readStream))
         do {
             try root = keyedUnarchiver.decodeTopLevelObject(forKey: NSKeyedArchiveRootObjectKey)
             keyedUnarchiver.finishDecoding()
@@ -113,11 +113,8 @@ open class NSKeyedUnarchiver : NSCoder {
         switch self._stream {
         case .data(let data):
             try plist = PropertyListSerialization.propertyList(from: data, options: [], format: &format)
-        case .stream(let inputStream):
-            try plist = PropertyListSerialization.propertyList(with: unsafeBitCast(inputStream, to: CFReadStream.self),
-                                                                           length: 0,
-                                                                           options: [],
-                                                                           format: &format)
+        case .stream(let readStream):
+            try plist = PropertyListSerialization.propertyList(with: readStream, options: [], format: &format)
         }
 
         guard let unwrappedPlist = plist as? Dictionary<String, Any> else {

diff --git a/Foundation/NSPropertyList.swift b/Foundation/NSPropertyList.swift
@@ -88,12 +88,12 @@ open class PropertyListSerialization : NSObject {
         }
     }
 
-    internal class func propertyList(with stream: CFReadStream, length streamLength: Int, options opt: ReadOptions, format: UnsafeMutablePointer <PropertyListFormat>?) throws -> Any {
+    internal class func propertyList(with stream: CFReadStream, options opt: ReadOptions, format: UnsafeMutablePointer <PropertyListFormat>?) throws -> Any {
         var fmt = kCFPropertyListBinaryFormat_v1_0
         var error: Unmanaged<CFError>? = nil
         let decoded = withUnsafeMutablePointer(to: &fmt) { (outFmt: UnsafeMutablePointer<CFPropertyListFormat>) -> NSObject? in
             withUnsafeMutablePointer(to: &error) { (outErr: UnsafeMutablePointer<Unmanaged<CFError>?>) -> NSObject? in
-                return unsafeBitCast(CFPropertyListCreateWithStream(kCFAllocatorSystemDefault, stream, streamLength, CFOptionFlags(CFIndex(opt.rawValue)), outFmt, outErr), to: NSObject.self)
+                return unsafeBitCast(CFPropertyListCreateWithStream(kCFAllocatorSystemDefault, stream, 0, CFOptionFlags(CFIndex(opt.rawValue)), outFmt, outErr), to: NSObject.self)
             }
         }
 #if os(OSX) || os(iOS)
@@ -109,6 +109,6 @@ open class PropertyListSerialization : NSObject {
     }
 
     open class func propertyList(with stream: InputStream, options opt: ReadOptions = [], format: UnsafeMutablePointer<PropertyListFormat>?) throws -> Any {
-        NSUnimplemented()
+        return try propertyList(with: stream._stream, options: opt, format: format)
     }
 }
diff --git a/Foundation/NSStream.swift b/Foundation/NSStream.swift
@@ -119,7 +119,7 @@ open class Stream: NSObject {
 // Subclassers are required to implement these methods.
 open class InputStream: Stream {
 
-    private var _stream: CFReadStream!
+    internal let _stream: CFReadStream!
 
     // reads up to length bytes into the supplied buffer, which must be at least of size len. Returns the actual number of bytes read.
     open func read(_ buffer: UnsafeMutablePointer<UInt8>, maxLength len: Int) -> Int {

diff --git a/TestFoundation/TestNSPropertyList.swift b/TestFoundation/TestNSPropertyList.swift
@@ -21,8 +21,9 @@ import SwiftXCTest
 class TestNSPropertyList : XCTestCase {
     static var allTests: [(String, (TestNSPropertyList) -> () throws -> Void)] {
         return [
-            ("test_BasicConstruction", test_BasicConstruction ),
-            ("test_decode", test_decode ),
+            ("test_BasicConstruction", test_BasicConstruction),
+            ("test_decodeData", test_decodeData),
+            ("test_decodeStream", test_decodeStream),
         ]
     }
 
@@ -39,7 +40,7 @@ class TestNSPropertyList : XCTestCase {
         XCTAssertEqual(data!.count, 42, "empty dictionary should be 42 bytes")
     }
 
-    func test_decode() {
+    func test_decodeData() {
         var decoded: Any?
         var fmt = PropertyListSerialization.PropertyListFormat.binary
         let path = testBundle().url(forResource: "Test", withExtension: "plist")
@@ -63,4 +64,30 @@ class TestNSPropertyList : XCTestCase {
             XCTFail("value stored is not a string")
         }
     }
+
+    func test_decodeStream() {
+        var decoded: Any?
+        var fmt = PropertyListSerialization.PropertyListFormat.binary
+        let path = testBundle().url(forResource: "Test", withExtension: "plist")
+        let stream = InputStream(url: path!)!
+        stream.open()
+        do {
+            decoded = try withUnsafeMutablePointer(to: &fmt) { (format: UnsafeMutablePointer<PropertyListSerialization.PropertyListFormat>) -> Any in
+                return try PropertyListSerialization.propertyList(with: stream, options: [], format: format)
+            }
+        } catch {
+
+        }
+
+        XCTAssertNotNil(decoded)
+        let dict = decoded as! Dictionary<String, Any>
+        XCTAssertEqual(dict.count, 3)
+        let val = dict["Foo"]
+        XCTAssertNotNil(val)
+        if let str = val as? String {
+            XCTAssertEqual(str, "Bar")
+        } else {
+            XCTFail("value stored is not a string")
+        }
+    }
 }