Skip to content

DarwinCompatibilty: Add shims for missing FileHandle methods #2558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 12, 2019
Merged

DarwinCompatibilty: Add shims for missing FileHandle methods #2558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions DarwinCompatibilityTests.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@
B9C89FCC1F6DCAEB00087AF4 /* NSKeyedUnarchiver-NotificationTest.plist in Resources */ = {isa = PBXBuildFile; fileRef = B9C89FB71F6DCAEB00087AF4 /* NSKeyedUnarchiver-NotificationTest.plist */; };
B9C89FCD1F6DCAEB00087AF4 /* PropertyList-1.0.dtd in Resources */ = {isa = PBXBuildFile; fileRef = B9C89FB81F6DCAEB00087AF4 /* PropertyList-1.0.dtd */; };
B9C89FCE1F6DCAEB00087AF4 /* Test.plist in Resources */ = {isa = PBXBuildFile; fileRef = B9C89FB91F6DCAEB00087AF4 /* Test.plist */; };
B9ED84FD23641F7000A58AF2 /* DarwinShims.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9F3269E1FC714DD003C3599 /* DarwinShims.swift */; };
B9F137A120B998D0000B7577 /* xdgTestHelper in CopyFiles */ = {isa = PBXBuildFile; fileRef = B917D31C20B0DB8B00728EE0 /* xdgTestHelper */; settings = {ATTRIBUTES = (CodeSignOnCopy, ); }; };
B9F326A01FC714DD003C3599 /* DarwinShims.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9F3269E1FC714DD003C3599 /* DarwinShims.swift */; };
DAE7D0F320D8224200DC6C54 /* TestURLProtectionSpace.swift in Sources */ = {isa = PBXBuildFile; fileRef = DAE7D0F220D8224200DC6C54 /* TestURLProtectionSpace.swift */; };
Expand Down Expand Up @@ -605,6 +606,7 @@
buildActionMask = 2147483647;
files = (
B917D32620B0DE2000728EE0 /* main.swift in Sources */,
B9ED84FD23641F7000A58AF2 /* DarwinShims.swift in Sources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand Down Expand Up @@ -727,7 +729,7 @@
CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
CODE_SIGN_STYLE = Automatic;
MACOSX_DEPLOYMENT_TARGET = 10.14;
MACOSX_DEPLOYMENT_TARGET = 10.15;
OTHER_SWIFT_FLAGS = "-DDEPLOYMENT_RUNTIME_OBJC -DDARWIN_COMPATIBILITY_TESTS";
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_VERSION = 5.0;
Expand All @@ -741,7 +743,7 @@
CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
CODE_SIGN_STYLE = Automatic;
MACOSX_DEPLOYMENT_TARGET = 10.14;
MACOSX_DEPLOYMENT_TARGET = 10.15;
OTHER_SWIFT_FLAGS = "-DDEPLOYMENT_RUNTIME_OBJC -DDARWIN_COMPATIBILITY_TESTS";
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_VERSION = 5.0;
Expand Down Expand Up @@ -796,7 +798,7 @@
GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
GCC_WARN_UNUSED_FUNCTION = YES;
GCC_WARN_UNUSED_VARIABLE = YES;
MACOSX_DEPLOYMENT_TARGET = 10.14;
MACOSX_DEPLOYMENT_TARGET = 10.15;
MTL_ENABLE_DEBUG_INFO = YES;
ONLY_ACTIVE_ARCH = YES;
SDKROOT = macosx;
Expand Down Expand Up @@ -847,7 +849,7 @@
GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
GCC_WARN_UNUSED_FUNCTION = YES;
GCC_WARN_UNUSED_VARIABLE = YES;
MACOSX_DEPLOYMENT_TARGET = 10.14;
MACOSX_DEPLOYMENT_TARGET = 10.15;
MTL_ENABLE_DEBUG_INFO = NO;
SDKROOT = macosx;
SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
Expand All @@ -861,7 +863,7 @@
COMBINE_HIDPI_IMAGES = YES;
INFOPLIST_FILE = DarwinCompatibilityTests/Info.plist;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks @loader_path/../Frameworks";
MACOSX_DEPLOYMENT_TARGET = 10.14;
MACOSX_DEPLOYMENT_TARGET = 10.15;
"OTHER_SWIFT_FLAGS[arch=*]" = "-DDEPLOYMENT_RUNTIME_OBJC -DDARWIN_COMPATIBILITY_TESTS";
PRODUCT_BUNDLE_IDENTIFIER = org.swift.DarwinCompatibilityTests;
PRODUCT_NAME = "$(TARGET_NAME)";
Expand All @@ -876,7 +878,7 @@
COMBINE_HIDPI_IMAGES = YES;
INFOPLIST_FILE = DarwinCompatibilityTests/Info.plist;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks @loader_path/../Frameworks";
MACOSX_DEPLOYMENT_TARGET = 10.14;
MACOSX_DEPLOYMENT_TARGET = 10.15;
"OTHER_SWIFT_FLAGS[arch=*]" = "-DDEPLOYMENT_RUNTIME_OBJC -DDARWIN_COMPATIBILITY_TESTS";
PRODUCT_BUNDLE_IDENTIFIER = org.swift.DarwinCompatibilityTests;
PRODUCT_NAME = "$(TARGET_NAME)";
Expand Down
6 changes: 0 additions & 6 deletions DarwinCompatibilityTests.xcodeproj/xcshareddata/xcschemes/xdgTestHelper.xcscheme
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,6 @@
<Test
Identifier = "TestDateComponents/test_hash()">
</Test>
<Test
Identifier = "TestFileHandle">
</Test>
<Test
Identifier = "TestPipe">
</Test>
<Test
Identifier = "TestURLComponents/test_hash()">
</Test>
Expand Down
24 changes: 24 additions & 0 deletions DarwinCompatibilityTests/DarwinShims.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,27 @@ extension NSCharacterSet {
return self as CharacterSet
}
}


extension FileHandle {
public func offset() throws -> UInt64 {
return self.offsetInFile
}

public func read(upToCount count: Int) throws -> Data? {
guard count > 0 else { return nil }
let data = readData(ofLength: count)
if data.count == 0 { return nil }
return data
}

public func readToEnd() throws -> Data? {
try read(upToCount: Int.max)
}

public func write<T: DataProtocol>(contentsOf data: T) throws {
if let d = data as? Data {
self.write(d)
}
}
}
3 changes: 0 additions & 3 deletions TestFoundation/TestFileHandle.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//

#if !DARWIN_COMPATIBILITY_TESTS // Disable until Foundation has the new FileHandle API

#if NS_FOUNDATION_ALLOWS_TESTABLE_IMPORT
#if canImport(SwiftFoundation) && !DEPLOYMENT_RUNTIME_OBJC
Expand Down Expand Up @@ -565,5 +564,3 @@ class TestFileHandle : XCTestCase {
return tests
}
}

#endif
2 changes: 0 additions & 2 deletions TestFoundation/TestPipe.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//

#if !DARWIN_COMPATIBILITY_TESTS // Disable until Foundation has the new FileHandle API

#if NS_FOUNDATION_ALLOWS_TESTABLE_IMPORT
#if canImport(SwiftFoundation) && !DEPLOYMENT_RUNTIME_OBJC
Expand Down Expand Up @@ -79,4 +78,3 @@ class TestPipe: XCTestCase {
XCTAssertEqual(text, convertedData)
}
}
#endif
26 changes: 3 additions & 23 deletions TestFoundation/TestProcess.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,7 @@ class TestProcess : XCTestCase {
try process.run()
let msg = try XCTUnwrap("Hello, 🐶.\n".data(using: .utf8))
do {
#if DARWIN_COMPATIBILITY_TESTS
inputPipe.fileHandleForWriting.write(msg)
#else
try inputPipe.fileHandleForWriting.write(contentsOf: msg)
#endif
} catch {
XCTFail("Cant write to pipe: \(error)")
return
Expand Down Expand Up @@ -585,14 +581,9 @@ class TestProcess : XCTestCase {
stdoutPipe.fileHandleForReading.readabilityHandler = nil

try dataLock.synchronized {
#if DARWIN_COMPATIBILITY_TESTS
// Use old API for now
stdoutData.append(stdoutPipe.fileHandleForReading.availableData)
#else
if let d = try stdoutPipe.fileHandleForReading.readToEnd() {
stdoutData.append(d)
}
#endif
XCTAssertEqual(String(data: stdoutData, encoding: .utf8)?.trimmingCharacters(in: .whitespacesAndNewlines), "No files specified.")
}
}
Expand Down Expand Up @@ -672,14 +663,9 @@ class TestProcess : XCTestCase {
}

var stdoutData = Data()
#if DARWIN_COMPATIBILITY_TESTS
// Use old API for now
stdoutData.append(stdoutPipe.fileHandleForReading.availableData)
#else
if let d = try stdoutPipe.fileHandleForReading.readToEnd() {
stdoutData.append(d)
}
#endif
if let d = try stdoutPipe.fileHandleForReading.readToEnd() {
stdoutData.append(d)
}

guard let stdout = String(data: stdoutData, encoding: .utf8) else {
throw Error.UnicodeDecodingError(stdoutData)
Expand Down Expand Up @@ -948,19 +934,13 @@ internal func runTask(_ arguments: [String], environment: [String: String]? = ni

return try dataLock.synchronized {
// Drain any data remaining in the pipes
#if DARWIN_COMPATIBILITY_TESTS
// Use old API for now
stdoutData.append(stdoutPipe.fileHandleForReading.availableData)
stderrData.append(stderrPipe.fileHandleForReading.availableData)
#else
if let d = try stdoutPipe.fileHandleForReading.readToEnd() {
stdoutData.append(d)
}

if let d = try stderrPipe.fileHandleForReading.readToEnd() {
stderrData.append(d)
}
#endif

guard let stdout = String(data: stdoutData, encoding: .utf8) else {
throw Error.UnicodeDecodingError(stdoutData)
Expand Down
4 changes: 0 additions & 4 deletions TestFoundation/TestScanner.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//

#if !DARWIN_COMPATIBILITY_TESTS // Disable until Foundation has the new Scanner API

fileprivate func withScanner(for string: String, invoking block: ((Scanner) throws -> Void)? = nil) rethrows {
let scanner = Scanner(string: string)
scanner.locale = Locale(identifier: "en_US_POSIX")
Expand Down Expand Up @@ -528,5 +526,3 @@ class TestScanner : XCTestCase {
]
}
}

#endif
4 changes: 0 additions & 4 deletions TestFoundation/Utilities.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,11 +528,7 @@ private var shouldRunXFailTests: Bool {


private func printStderr(_ msg: String) {
#if DARWIN_COMPATIBILITY_TESTS
FileHandle.standardError.write(Data(msg.utf8))
#else
try? FileHandle.standardError.write(contentsOf: Data(msg.utf8))
#endif
}

func shouldAttemptXFailTests(_ reason: String) -> Bool {
Expand Down
10 changes: 0 additions & 10 deletions TestFoundation/xdgTestHelper/main.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,19 +180,9 @@ func cat(_ args: ArraySlice<String>.Iterator) {
exitCode = 1
return
}
#if DARWIN_COMPATIBILITY_TESTS
var data: Data
repeat {
data = fh.readData(ofLength: Int.max)
if data.count > 0 {
FileHandle.standardOutput.write(data)
}
} while data.count > 0
#else
while let data = try fh.readToEnd() {
try FileHandle.standardOutput.write(contentsOf: data)
}
#endif
}
catch { print(error) }
}
Expand Down