Skip to content
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

Special-case FileHandle(forWritingAtPath: "CONOUT$") on Windows. #654

Merged
merged 2 commits into from
Aug 30, 2024
Merged

Special-case FileHandle(forWritingAtPath: "CONOUT$") on Windows. #654

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c321da6
Special-case `FileHandle(forWritingAtPath: "CONOUT$")` on Windows.
grynspan Aug 30, 2024
8c59fcc
Move it up to the real fopen() bottleneck
grynspan Aug 30, 2024
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
15 changes: 15 additions & 0 deletions Sources/Testing/Support/FileHandle.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,21 @@ struct FileHandle: ~Copyable, Sendable {
/// - Throws: Any error preventing the stream from being opened.
init(atPath path: String, mode: String) throws {
#if os(Windows)
// Special-case CONOUT$ to map to stdout. This way, if somebody specifies
// CONOUT$ as the target path for XML or JSON output from `swift test`,
// output will be correctly interleaved with writes to `stdout`. If we don't
// do this, the file will open successfully but will be opened in text mode
// (even if we ask for binary mode), will wrap at the virtual console's
// column limit, and won't share a file lock with the C `stdout` handle.
//
// To our knowledge, this sort of special-casing is not required on
// POSIX-like platforms (i.e. when opening "/dev/stdout"), but it can be
// adapted for use there if some POSIX-like platform does need it.
if path == "CONOUT$" && mode.contains("w") {
self = .stdout
return
}

// Windows deprecates fopen() as insecure, so call _wfopen_s() instead.
let fileHandle = try path.withCString(encodedAs: UTF16.self) { path in
try mode.withCString(encodedAs: UTF16.self) { mode in
Expand Down