Compare commits

..
Author SHA1 Message Date
Karoy Lorentey aabb8d0019 Merge pull request #123 from lorentey/update-gitignore
Update gitignore
2023-04-10 17:02:04 -07:00
Karoy Lorentey f059b4bfb3 Merge pull request #125 from compnerd/arm64
build: add ARM64 for mapping on Windows
2023-03-02 11:37:14 -08:00
Karoy Lorentey 64486e7d26 Merge pull request #124 from lorentey/tweak-availability-declarations
Fix expand-availability syntax not to interfere with doc comment parsing
2023-03-02 11:34:38 -08:00
Saleem Abdulrasool 9674a9fee8 build: add ARM64 for mapping on Windows
Windows uses `ARM64` for `CMAKE_SYSTEM_PROCESSOR` which doesn't match
the current spellings.
2023-03-02 10:56:49 -08:00
Karoy Lorentey bb6ab43e44 Update availability declarations 2023-03-01 18:10:40 -08:00
Karoy Lorentey e86702b34a Fix expand-availability syntax not to interfere with doc comment parsing
This was our previous convention:

    /// Fiddle with the thing.
    /*System 0.0.2*/
    public func foo()

    /// Fiddle with the thing.
    /*System 0.0.2, @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)*/
    public func foo()

    /// Fiddle with the thing.
    /*System 0.0.2*/@available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
    public func foo()

Unfortunately, regular comments in between a declaration and its
preceding doc comments interfere with documentation tools.

Change things to the style below instead:

    /// Fiddle with the thing.
    @available(/*System 0.0.2*/macOS 10, *)
    public func foo()

    /// Fiddle with the thing.
    @available(/*SwiftSystem 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/macOS 10, *)
    public func foo()

    /// Fiddle with the thing.
    @available(/*SwiftSystem 0.0.2*/macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
    public func foo()

Unfortunately, `@available(*)` isn’t valid syntax, so we have to
add a dummy “macOS 10” version spec. It should have no actual effect.
2023-03-01 18:10:38 -08:00
Karoy Lorentey cee9335aeb Update gitignore 2023-03-01 16:29:39 -08:00
Karoy Lorentey f572e4becb Merge pull request #122 from lorentey/inlinable-mach-ports
Mach: Avoid non-inlinable generics where possible
2023-02-28 18:22:00 -08:00
Karoy Lorentey e708e4adda Mach: Avoid non-inlinable generics where possible
- Leave Ports as non-frozen for now, but expose its two stored
  properties.
- Make most members inlinable. The core initializers and the
  deinitializer must remain opaque for now.
- Mark the empty `MachPortRight` types as `@frozen` — these are
  markers, not carrying any data.

rdar://106057781
2023-02-28 17:05:18 -08:00
Karoy Lorentey cc96d40bee Merge pull request #76 from apple/lorentey/post-back-ios15-system
Update package with changes from recent ABI stable releases
2023-02-28 16:13:44 -08:00
loffgren 9cdaaa356e Merge pull request #121 from loffgren/machport_fixes
Mach.Port: Tidiness
2023-02-22 09:55:03 -08:00
Daniel Loffgren 16c7885387 Move public annotations from extensions down to each function explicitly 2023-02-21 16:03:31 -08:00
Alex Martini 08e9abe4e6 Merge pull request #119 from amartini51/doc_comment_placement
Fix doc comment placement
2023-02-14 11:23:02 -08:00
Daniel Loffgren 0fb71dd6ad Fit all function signatures within 80 cols 2023-02-13 23:53:06 -08:00
Daniel Loffgren 16a2775645 Annotate entire Mach namespace as being available in System 1.3.0 2023-02-13 17:53:42 -08:00
Daniel Loffgren 7c11f19259 Add System 1.3.0 to expand-availability.py 2023-02-13 17:53:03 -08:00
Daniel Loffgren 13bf719c29 Freeze the Mach namespace, as it should only ever be used as a namespace 2023-02-10 18:04:55 -08:00
Daniel Loffgren 3750b96b2e name and context should have leading underscores 2023-02-10 18:03:31 -08:00
Daniel Loffgren 12baba9706 machPrecondition should have a leading underscore 2023-02-10 17:59:16 -08:00
Alex Martini 2c2a831f66 Remove blank lines at the end of doc comments. 2023-01-31 12:35:33 -08:00
Alex Martini deb56e1ad2 Keep doc comments immediately before declarations.
If there's anything between them, DocC doesn't recognize that the doc
comment belongs to the declaration that comes after the interruption,
resulting in that declaration being undocumented.
2023-01-31 12:07:17 -08:00
Karoy Lorentey a2bf0d5708 Merge pull request #118 from apple/maxd/fix-5.7-errors 2023-01-10 09:40:44 -08:00
Max Desiatov b5e330163a MachPortTests: fix build issues with Swift 5.7 2023-01-05 14:35:22 +00:00
Max Desiatov 3f66dfbaf8 MachPort: fix build issues with Swift 5.7
It seems that `#if $MoveOnly` check has no effect on Swift 5.7, so we should check whether Swift 5.8 or later are available first.

Resolves #117.
2023-01-05 10:58:04 +00:00
Karoy Lorentey ccea4eed1a Merge pull request #116 from loffgren/machports
Add Mach.Port
2022-12-22 18:15:38 -08:00
Daniel Loffgren 700b8f867e Use two space indentation 2022-12-22 18:01:40 -08:00
loffgrenandKaroy Lorentey d129f62ce9 Use Markdown code voice for initializer comment
Co-authored-by: Karoy Lorentey <klorentey@apple.com>
2022-12-22 17:12:26 -08:00
loffgrenandMichael Ilseman ae6b1f24a9 Remove space before inheritance colon
Co-authored-by: Michael Ilseman <michael.ilseman@gmail.com>
2022-12-22 14:52:36 -08:00
Daniel Loffgren 47feb93a38 Add a test that ensures makeSendOnce is creating unique send-once rights 2022-12-21 13:43:26 -08:00
Daniel Loffgren 6a9ebce259 Add public annotations where applicable 2022-12-21 13:20:38 -08:00
Daniel Loffgren 7f4560f022 Remove unnecessary RightTypes for Mach.Ports being constructed inline with a return 2022-12-21 13:12:13 -08:00
Daniel Loffgren 6dd57fe3a9 Add a friendly precondition message for the MACH_PORT_NULL check 2022-12-21 12:57:25 -08:00
Daniel Loffgren 551d7b897f Use mach_port_destruct() to deinit receive rights eliminating the second syscall, and use mach_port_mod_refs() for all other right types to get a free type check at deinit time
mach_port_mod_refs() requires the type of right being modified.  So,
MACH_PORT_DEAD must be identified as a separate type. As this is
something that shouldn't be possible for receive rights, preconditions
have also been added to protect against this particular error.
2022-12-21 12:53:47 -08:00
Daniel Loffgren 296374ecef Label tuple contents for allocatePortPair() and relinquish() 2022-12-21 11:46:06 -08:00
Daniel Loffgren 213165ab72 size should be the number of natural_t's 2022-12-20 15:45:17 -08:00
Daniel Loffgren bd036acda6 Storage should be initialized to MACH_PORT_NULL, rather than 0 2022-12-20 15:45:17 -08:00
Daniel Loffgren 4536c47763 Use precondition instead of assert, adding a machPrecondition for the common KERN_SUCCESS check 2022-12-20 15:45:17 -08:00
Daniel Loffgren bdc776bd3e Correct parameter whitespace 2022-12-19 17:14:53 -08:00
loffgrenandMatt Wright c2d940ecf3 Remove parens around RightType condition in initializer
Co-authored-by: Matt Wright <mww@apple.com>
2022-12-19 16:41:33 -08:00
Daniel Loffgren 304ccc3abb Add Mach.Port 2022-12-07 17:24:26 -08:00
Florian Friedrich 77d9ca18c1 Add Sendable conformances (#115) 2022-11-30 14:04:49 -07:00
3405691582 18cceda484 Support OpenBSD. (#113)
Add the usual `os` conditionals and exclude errno constants that aren't
present on this platform.

Maybe availability annotations are a better way to deal with this, but
that is likely something that requires more careful consideration.
2022-10-31 09:22:05 -06:00
Saleem Abdulrasool 252c0f0905 Merge pull request #109 from krzyzanowskim/marcin/quote-cmake-include
Quote cmake include path
2022-09-17 08:42:39 -07:00
Marcin Krzyzanowski e1f6974ba6 Quote include path 2022-09-10 02:21:53 +02:00
Alex Martini 015e9baf40 Fix a broken link. (#107) 2022-08-23 07:21:09 -06:00
Daniel Duan 036f567f23 Remove Windows warnings (#105)
These calls are missing their Windows counter parts, resulting warnings
stating `X is deprecated: The POSIX name for this item is deprecated.
Instead, use the ISO C and C++ conformant name: Y. See online help for
details`.

Add them like the rest.
2022-06-21 09:50:24 -06:00
Saleem Abdulrasool 348b4de820 Merge pull request #99 from compnerd/file-flags
Tests: remove some flags from file tests
2022-06-18 09:44:43 -07:00
Saleem Abdulrasool e378fb2f0d Tests: ignore XCTest manifest on newer Swift (#91)
This is motivated by the desire to build the test suite on Windows.
Newer versions of SPM have test discovery which obviates the test
manifest, which incidentally repairs the build on Windows while adopting
newer functionality and reducing management complexity.
2022-06-15 10:00:23 -06:00
Karoy Lorentey e9886bf251 Merge branch 'main' into lorentey/post-back-ios15-system
# Conflicts:
#	Sources/System/FilePath/FilePathString.swift
2022-06-13 16:45:25 -07:00
Karoy Lorentey 63cdebeff6 Merge pull request #95 from compnerd/chartype
Tests: explicitly convert the character type
2022-06-13 16:32:28 -07:00
Karoy Lorentey 97a03f97c8 Merge pull request #103 from compnerd/array
Tests: change the conversion for string to array
2022-06-13 16:30:40 -07:00
Karoy Lorentey 0a7e8e121b Merge pull request #100 from compnerd/utf16
Tests: explicitly convert to UTF16 on Windows
2022-06-13 16:14:41 -07:00
Karoy Lorentey a102156af3 Merge pull request #96 from compnerd/not-errno
Tests: remove error codes that are unavailable on windows
2022-06-13 14:59:59 -07:00
Karoy Lorentey dc5a3107c0 Merge pull request #102 from compnerd/underlying
Tests: adjust the Windows error codes
2022-06-13 14:55:14 -07:00
Karoy Lorentey bcba321273 Merge pull request #104 from compnerd/validity
Tests: adjust invalid character
2022-06-13 14:34:45 -07:00
Saleem Abdulrasool a5c43b17a9 Tests: adjust invalid character
Adjust the injected character to be an invalid UTF-16 and UTF-8
character.  This is required to make the tests pass on Windows.
2022-06-12 14:34:12 -07:00
Saleem Abdulrasool 429f64259f Tests: adjust the Windows error codes
The Windows error codes are not re-exported, explicitly import the
WinSDK module to gain access to the error codes.  Add Windows specific
checks to ensure that the named forms match the underlying
implementation.
2022-06-12 12:35:54 -07:00
Saleem Abdulrasool 18c5f7a54b Tests: change the conversion for string to array
Windows uses UTF16 for the platform character, not UTF8, and does not
map to CChar.  Add a Windows path for the conversion.
2022-06-12 11:59:43 -07:00
Saleem Abdulrasool f9a514897e Tests: explicitly convert to UTF16 on Windows
File paths on Windows are represented in UTF16, while Swift strings are
UTF8.  Explicitly convert from UTF16 on Windows.
2022-06-12 11:37:47 -07:00
Saleem Abdulrasool 8e247d927e Tests: remove some flags from file tests
Windows does not support some flags (e.g. `O_CLOEXEC`).  This removes
the unsupported options on Windows.
2022-06-12 11:33:45 -07:00
Saleem Abdulrasool 59ddf00c8e Tests: remove error codes that are unavailable on windows
Not all the error codes are available on Windows, this matches
SystemErrno cases to remove the cases that have no definition on
Windows.
2022-06-12 11:21:16 -07:00
Saleem Abdulrasool 6d8abddbc8 Tests: explicitly convert the character type
The platform character type is different across Unix and Windows.
Explicitly convert the value to the expected type.
2022-06-11 14:50:35 -07:00
Karoy Lorentey 025bcb1165 Merge pull request #93 from apple/revert-89-sb/resize-windows
Revert "FileOperations: Add Windows implementation for FileDescriptor.resize(to:)"
2022-06-11 12:57:28 -07:00
Karoy Lorentey f5e4aac51b Revert "FileOperations: Add Windows implementation for FileDescriptor.resize(to:) (#89)"
This reverts commit 94fa6bd2ff.
2022-06-11 12:54:19 -07:00
Si Beaumont 94fa6bd2ff FileOperations: Add Windows implementation for FileDescriptor.resize(to:) (#89)
* FileOperations: Add Windows implementation for FileDescriptor.resize(to:)

Replace _chsize with _chsize_s on Windows
2022-06-09 09:51:28 -06:00
Alsey Coleman Miller a552fda216 Import C module as @_implementationOnly (#83) 2022-06-08 19:54:55 -06:00
Guillaume Lessard bdb13a5a80 Merge pull request #80 from apple/glessard/rdar91436410
Mitigate misuse of Swift's pointer conversion feature
2022-06-03 16:52:30 -06:00
Guillaume Lessard 3920df78d9 Correct deprecation messages 2022-06-03 16:43:25 -06:00
Guillaume Lessard 469ede0fa2 Add tests for every new overload added 2022-06-03 16:43:25 -06:00
Guillaume Lessard afe2d35d0b Mitigate misuse of pointer conversion in FilePath inits 2022-06-03 16:43:25 -06:00
Guillaume Lessard 25380a1bea Mitigate misuse of pointer conversion in String inits 2022-06-03 16:43:25 -06:00
Karoy Lorentey 74eb6f4ef8 Merge pull request #77 from amartini51/docs/develop
Fix broken links.
2022-06-03 15:37:23 -07:00
Alex Martini 6db5a4a43b Fix broken links.
Fixes rdar://79096457
2022-06-03 15:23:53 -07:00
Karoy Lorentey 5ba9e8fa77 Merge pull request #79 from apple/glessard/binding-fixes
Rebind byte types safely
2022-06-03 15:16:40 -07:00
Guillaume Lessard 914c782b96 Replace assumingMemoryBound with temporary rebinding
- this doesn’t use the new memory binding API.
2022-05-27 18:09:45 -06:00
Karoy Lorentey 82a6704912 Merge pull request #88 from apple/lorentey/unbroke-windows
Unbreak the Windows port
2022-05-21 12:46:19 -07:00
Karoy Lorentey bd5a7bb703 Remove test of minimal value 2022-05-21 12:44:00 -07:00
Karoy Lorentey 147ebc053a Unbreak the Windows port 2022-05-21 12:43:59 -07:00
Karoy Lorentey 5c18991f29 Merge pull request #82 from simonjbeaumont/sb/resize
FileDescriptor: Add resize(to newSize:) and fileSize() APIs
2022-05-20 11:30:26 -07:00
Si Beaumont 7bb5279b57 fixup: Tests run in parallel; use unique temp file name
Signed-off-by: Si Beaumont <beaumont@apple.com>
2022-05-20 19:25:41 +01:00
Si Beaumont 865fd70605 Merge branch 'main' into sb/resize 2022-05-20 18:26:33 +01:00
Si Beaumont ca6e888455 Utilities: Add version 1.2.0 to expand-availability.py tool
Signed-off-by: Si Beaumont <beaumont@apple.com>
2022-05-20 18:24:28 +01:00
Si Beaumont fea7d5030d docs: Removed duplicate paragraph from FileDescriptor.writeAll(_:) docs (#85) 2022-05-16 07:28:47 -07:00
Si Beaumont d90bf8529a fixup: Move FileDescriptor.fileSize() to an internal extension in SystemTests 2022-05-06 11:55:00 +01:00
Si Beaumont 02daf4b6a7 fixup: Move FileDescriptor.resize to extension with #if !os(Windows) 2022-05-06 11:55:00 +01:00
Si Beaumont 7fab65f340 fixup: Remove Windows syscall adaptor for ftruncate 2022-05-06 11:09:20 +01:00
Si Beaumont 5d3519dcef FileOperations: Add FileDescriptor.resize, using ftruncate(2)
Signed-off-by: Si Beaumont <beaumont@apple.com>
2022-05-05 08:24:48 +01:00
Si Beaumont 23ac190631 FileHelpers: Add FileDescriptor.fileSize
Signed-off-by: Si Beaumont <beaumont@apple.com>
2022-05-04 12:33:03 +01:00
Daniel Duan a77a331dc7 Update Linux test manifests (#81)
Run `swift package --generate-linuxmain` results in this patch.
2022-04-20 14:22:03 -06:00
Karoy Lorentey ca700460b1 Fix compatibility with Swift 5.3.3 2021-12-26 22:00:07 -08:00
Karoy Lorentey 81d78be499 Fix Windows build 2021-12-26 21:53:28 -08:00
Karoy Lorentey 915070e006 Add Internals/Backcompat.swift to CMake config 2021-12-21 18:40:27 -08:00
Karoy Lorentey 6469433909 Work around memset taking a non-optional pointer on Linux 2021-12-21 17:50:21 -08:00
Karoy Lorentey c0e8ef346b Update package with changes from recent ABI stable releases
This brings the contents of this package up to date with versions of the ABI stable `System` module that shipped in recent iOS/macOS releases.

Most changes only touch internal implementation details, but some ABI-related fixes also affect the public API. There are no source-incompatible changes.

- ABI stability fixes (un-deprecate CModeT, don't use PlatformChar in inlinable contexts that need to deploy to iOS 14)
- New utilities: `_RawBuffer`, `Array<String>._withCStringArray`, `_withOptionalUnsafePointerOrNull`, `_withStackBuffer`, `system_memset`
- Prefer using explicit optionals to implicitly-unwrapped ones
- Add support for wildcard matching in mocking tests
- A bunch of new availability annotations. (I expect there will be more of these coming in future PRs.)
2021-12-21 17:50:21 -08:00
Karoy Lorentey 1d5e35a460 Merge pull request #75 from lorentey/introduce-availability-macros
Unify availability annotations & introduce a script to manage them
2021-12-21 13:07:07 -08:00
Karoy Lorentey fd82b5a0ce Fix docs 2021-12-20 17:52:59 -08:00
Karoy Lorentey 0c24d31e08 Add script to manage availability annotations
By running this script, we can expand comments of the form

```
/*System 0.0.1*/
```

Into either a longer comment that includes the associated OS versions numbers,

```
/*System 0.0.1, @available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *)*/
```

or, when the `--attribute` option is used, into an actual `@available` attribute:

```
/*System 0.0.1*/@available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
```

The script can be run repeatedly to switch between these two forms, as needed.
2021-12-20 17:14:42 -08:00
Karoy Lorentey 1daa0c9677 Unify availability annotations and synchronize them with macOS 12 / iOS 15
Availability annotations now follow a rigid syntax that mentions the swift-system version that introduced the entry point:

```
/*System 0.0.2, @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)*/
public func greeting() -> String {
  "Hello"
}
```

This is designed to be processed by automated source generation tools.
2021-12-20 17:10:59 -08:00
Saleem Abdulrasool 836bc4557b Merge pull request #74 from compnerd/leaky-cauldron
build: install CSystem into the system
2021-12-02 11:22:32 -08:00
Saleem Abdulrasool 5d68cf0eca build: install CSystem into the system
CSystem is a leaky library dependency from System and must be
distributed.  Install the files and make the dependency public so that
it is emitted into the clients.
2021-12-02 09:19:43 -08:00
tomer doron 5703dc2b4d update cmake setup so that the library can be used by SwiftPM cmake build (#73)
Update cmake setup so that the library can be used by SwiftPM cmake build

Motivation: integrate with SwiftPM

changes:
* rename the top level project to SwiftSystem instead of swift-system to align with other projects
* rename System to SystemPackage to align with SwifPM setup
* update architectures to include arm64
* Update cmake/modules/SwiftSystemConfig.cmake.in
* Update cmake/modules/SwiftSupport.cmake
2021-11-30 10:50:50 -07:00
Alex Martini 2fa26782e1 Merge pull request #69 from amartini51/docs/develop
Minor fixes in documentation comments
2021-11-09 10:11:05 -08:00
Alex Martini 0c291a65c2 Fix typo.
Fixes <rdar://problem/84559893>.
2021-11-08 19:43:49 -08:00
Alex Martini 0ac080ea56 Add missing period at end of abstract. 2021-11-08 19:43:30 -08:00
Alex Martini d2c4e4507a Fix spacing and indentation. 2021-11-08 19:43:30 -08:00
Alex Martini 78847afcd4 Remove stray word. 2021-11-08 19:43:30 -08:00
George Lyon 689390f50f Implement FileDescriptor.Pipe() (#58)
Adds support for pipe(2)
2021-09-27 16:02:52 -06:00
Michael Ilseman ce8b491073 Update README for 1.0 2021-09-01 09:26:18 -06:00
YR Chen 39774ef16a Simplify Package.swift 2021-08-05 10:05:06 -06:00
YR Chen 58a2725013 Fix building on Windows 2021-08-05 10:05:06 -06:00
Rauhul Varma e520e61616 Fix SystemChar isLetter logic
- Fixes range expression in isLetter logic and adds test coverage.
2021-08-05 10:03:53 -06:00
Rauhul Varma 4f36710d0b Expose O_DIRECTORY as api
- Adds a `directory` OpenOptions as a type-safe version of O_DIRECTORY.
  Allows clients to only open a FileDescriptor for FilePaths that refer
  to directories.
2021-07-14 18:24:52 -06:00
Alex Martini 591ff41944 Move TODO and FIXME markers to normal comments.
When they appear in triple-slash comments, that makes them part of the
actual documentation that gets published.

Fixes <rdar://problem/79071171>.
2021-06-10 16:34:32 -06:00
51 changed files with 2232 additions and 294 deletions

No files matched your search

+3 -1
View File
@@ -1,6 +1,8 @@
.DS_Store
/.swiftpm
/.build
/Packages
/*.xcodeproj
swift-system.xcodeproj
xcuserdata/
.*.sw?
.docc-build
+2 -7
View File
@@ -8,7 +8,7 @@ See https://swift.org/LICENSE.txt for license information
#]]
cmake_minimum_required(VERSION 3.16.0)
project(swift-system
project(SwiftSystem
LANGUAGES C Swift)
list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/modules)
@@ -21,9 +21,4 @@ set(CMAKE_Swift_MODULE_DIRECTORY ${CMAKE_BINARY_DIR}/swift)
include(SwiftSupport)
add_subdirectory(Sources)
get_property(SWIFT_SYSTEM_EXPORTS GLOBAL PROPERTY SWIFT_SYSTEM_EXPORTS)
export(TARGETS ${SWIFT_SYSTEM_EXPORTS}
NAMESPACE SwiftSystem::
FILE swift-system-config.cmake
EXPORT_LINK_INTERFACE_LIBRARIES)
add_subdirectory(cmake/modules)
+22 -21
View File
@@ -12,31 +12,32 @@
import PackageDescription
let targets: [PackageDescription.Target] = [
.target(
name: "SystemPackage",
dependencies: ["CSystem"],
path: "Sources/System",
swiftSettings: [
.define("SYSTEM_PACKAGE"),
.define("ENABLE_MOCKING", .when(configuration: .debug))
]),
.target(
name: "CSystem",
dependencies: []),
.testTarget(
name: "SystemTests",
dependencies: ["SystemPackage"],
swiftSettings: [
.define("SYSTEM_PACKAGE")
]),
]
let package = Package(
name: "swift-system",
products: [
.library(name: "SystemPackage", targets: ["SystemPackage"]),
],
dependencies: [],
targets: targets
targets: [
.target(
name: "CSystem",
dependencies: []),
.target(
name: "SystemPackage",
dependencies: ["CSystem"],
path: "Sources/System",
cSettings: [
.define("_CRT_SECURE_NO_WARNINGS")
],
swiftSettings: [
.define("SYSTEM_PACKAGE"),
.define("ENABLE_MOCKING", .when(configuration: .debug))
]),
.testTarget(
name: "SystemTests",
dependencies: ["SystemPackage"],
swiftSettings: [
.define("SYSTEM_PACKAGE")
]),
]
)
+8 -11
View File
@@ -28,16 +28,7 @@ To use the `SystemPackage` library in a SwiftPM project,
add the following line to the dependencies in your `Package.swift` file:
```swift
.package(url: "https://github.com/apple/swift-system", from: "0.0.1"),
```
Because `SystemPackage` is under active development,
source-stability is only guaranteed within minor versions (e.g. between `0.0.3` and `0.0.4`).
If you don't want potentially source-breaking package updates,
use this dependency specification instead:
```swift
.package(url: "https://github.com/apple/swift-system", .upToNextMinor(from: "0.0.1")),
.package(url: "https://github.com/apple/swift-system", from: "1.0.0"),
```
Finally, include `"SystemPackage"` as a dependency for your executable target:
@@ -46,7 +37,7 @@ Finally, include `"SystemPackage"` as a dependency for your executable target:
let package = Package(
// name, platforms, products, etc.
dependencies: [
.package(url: "https://github.com/apple/swift-system", from: "0.0.1"),
.package(url: "https://github.com/apple/swift-system", from: "1.0.0"),
// other dependencies
],
targets: [
@@ -58,6 +49,12 @@ let package = Package(
)
```
## Source Stability
The Swift System package is source stable. The version numbers follow [Semantic Versioning][semver] -- source breaking changes to public API can only land in a new major version.
[semver]: https://semver.org
## Contributing
Before contributing, please read [CONTRIBUTING.md](CONTRIBUTING.md).
+5
View File
@@ -12,4 +12,9 @@ target_include_directories(CSystem INTERFACE
include)
install(FILES
include/CSystemLinux.h
include/CSystemWindows.h
include/module.modulemap
DESTINATION include/CSystem)
set_property(GLOBAL APPEND PROPERTY SWIFT_SYSTEM_EXPORTS CSystem)
+12 -6
View File
@@ -7,17 +7,21 @@ Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
#]]
add_library(System
add_library(SystemPackage
Errno.swift
FileDescriptor.swift
FileHelpers.swift
FileOperations.swift
FilePermissions.swift
MachPort.swift
PlatformString.swift
SystemString.swift
Util.swift
Util+StringArray.swift
UtilConsumers.swift)
target_sources(System PRIVATE
set_target_properties(SystemPackage PROPERTIES
INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
target_sources(SystemPackage PRIVATE
FilePath/FilePath.swift
FilePath/FilePathComponents.swift
FilePath/FilePathComponentView.swift
@@ -25,16 +29,18 @@ target_sources(System PRIVATE
FilePath/FilePathString.swift
FilePath/FilePathSyntax.swift
FilePath/FilePathWindows.swift)
target_sources(System PRIVATE
target_sources(SystemPackage PRIVATE
Internals/Backcompat.swift
Internals/CInterop.swift
Internals/Constants.swift
Internals/Exports.swift
Internals/Mocking.swift
Internals/RawBuffer.swift
Internals/Syscalls.swift
Internals/WindowsSyscallAdapters.swift)
target_link_libraries(System PRIVATE
target_link_libraries(SystemPackage PUBLIC
CSystem)
_install_target(System)
set_property(GLOBAL APPEND PROPERTY SWIFT_SYSTEM_EXPORTS System)
_install_target(SystemPackage)
set_property(GLOBAL APPEND PROPERTY SWIFT_SYSTEM_EXPORTS SystemPackage)
+10 -6
View File
@@ -10,7 +10,7 @@
/// An error number used by system calls to communicate what kind of error
/// occurred.
@frozen
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
public struct Errno: RawRepresentable, Error, Hashable, Codable {
/// The raw C error number.
@_alwaysEmitIntoClient
@@ -1274,6 +1274,7 @@ public struct Errno: RawRepresentable, Error, Hashable, Codable {
@available(*, unavailable, renamed: "badMessage")
public static var EBADMSG: Errno { badMessage }
#if !os(OpenBSD)
/// Reserved.
///
/// This error is reserved for future use.
@@ -1333,6 +1334,7 @@ public struct Errno: RawRepresentable, Error, Hashable, Codable {
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "notStream")
public static var ENOSTR: Errno { notStream }
#endif
/// Protocol error.
///
@@ -1348,6 +1350,7 @@ public struct Errno: RawRepresentable, Error, Hashable, Codable {
@available(*, unavailable, renamed: "protocolError")
public static var EPROTO: Errno { protocolError }
#if !os(OpenBSD)
/// Reserved.
///
/// This error is reserved for future use.
@@ -1359,6 +1362,7 @@ public struct Errno: RawRepresentable, Error, Hashable, Codable {
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "timeout")
public static var ETIME: Errno { timeout }
#endif
#endif
/// Operation not supported on socket.
@@ -1376,7 +1380,7 @@ public struct Errno: RawRepresentable, Error, Hashable, Codable {
}
// Constants defined in header but not man page
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension Errno {
/// Operation would block.
@@ -1470,7 +1474,7 @@ extension Errno {
#endif
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension Errno {
// TODO: We want to provide safe access to `errno`, but we need a
// release-barrier to do so.
@@ -1485,14 +1489,14 @@ extension Errno {
}
// Use "hidden" entry points for `NSError` bridging
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension Errno {
public var _code: Int { Int(rawValue) }
public var _domain: String { "NSPOSIXErrorDomain" }
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension Errno: CustomStringConvertible, CustomDebugStringConvertible {
/// A textual representation of the most recent error
/// returned by a system call.
@@ -1512,7 +1516,7 @@ extension Errno: CustomStringConvertible, CustomDebugStringConvertible {
public var debugDescription: String { self.description }
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension Errno {
@_alwaysEmitIntoClient
public static func ~=(_ lhs: Errno, _ rhs: Error) -> Bool {
+37 -11
View File
@@ -14,7 +14,7 @@
/// of `FileDescriptor` values,
/// in the same way as you manage a raw C file handle.
@frozen
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
public struct FileDescriptor: RawRepresentable, Hashable, Codable {
/// The raw C file handle.
@_alwaysEmitIntoClient
@@ -25,7 +25,8 @@ public struct FileDescriptor: RawRepresentable, Hashable, Codable {
public init(rawValue: CInt) { self.rawValue = rawValue }
}
// Standard file descriptors
// Standard file descriptors.
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FileDescriptor {
/// The standard input file descriptor, with a numeric value of 0.
@_alwaysEmitIntoClient
@@ -40,7 +41,7 @@ extension FileDescriptor {
public static var standardError: FileDescriptor { .init(rawValue: 2) }
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FileDescriptor {
/// The desired read and write access for a newly opened file.
@frozen
@@ -106,7 +107,7 @@ extension FileDescriptor {
/// the system doesn't wait for the device or file
/// to be ready or available.
/// If the
/// <doc:System/FileDescriptor/open(_:_:options:permissions:)-10dcs>
/// <doc:FileDescriptor/open(_:_:options:permissions:retryOnInterrupt:)-2266j>
/// call would result in the process being blocked for some reason,
/// that method returns immediately.
/// This flag also has the effect of making all
@@ -164,14 +165,14 @@ extension FileDescriptor {
/// expecting that it doesn't exist.
///
/// If this option and ``create`` are both specified and the file exists,
/// <doc:System/FileDescriptor/open(_:_:options:permissions:)-10dcs>
/// <doc:FileDescriptor/open(_:_:options:permissions:retryOnInterrupt:)-2266j>
/// returns an error instead of creating the file.
/// You can use this, for example,
/// to implement a simple exclusive-access locking mechanism.
///
/// If this option and ``create`` are both specified
/// and the last component of the file's path is a symbolic link,
/// <doc:System/FileDescriptor/open(_:_:options:permissions:)-10dcs>
/// <doc:FileDescriptor/open(_:_:options:permissions:retryOnInterrupt:)-2266j>
/// fails even if the symbolic link points to a nonexistent name.
///
/// The corresponding C constant is `O_EXCL`.
@@ -223,7 +224,7 @@ extension FileDescriptor {
///
/// If you specify this option
/// and the file path you pass to
/// <doc:System/FileDescriptor/open(_:_:options:permissions:)-10dcs>
/// <doc:FileDescriptor/open(_:_:options:permissions:retryOnInterrupt:)-2266j>
/// is a symbolic link,
/// then that open operation fails.
///
@@ -234,6 +235,20 @@ extension FileDescriptor {
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "noFollow")
public static var O_NOFOLLOW: OpenOptions { noFollow }
/// Indicates that opening the file only succeeds if the file is a directory.
///
/// If you specify this option and the file path you pass to
/// <doc:FileDescriptor/open(_:_:options:permissions:retryOnInterrupt:)-2266j>
/// is a not a directory, then that open operation fails.
///
/// The corresponding C constant is `O_DIRECTORY`.
@_alwaysEmitIntoClient
public static var directory: OpenOptions { OpenOptions(_O_DIRECTORY) }
@_alwaysEmitIntoClient
@available(*, unavailable, renamed: "directory")
public static var O_DIRECTORY: OpenOptions { directory }
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
@@ -242,7 +257,7 @@ extension FileDescriptor {
///
/// If you specify this option
/// and the file path you pass to
/// <doc:System/FileDescriptor/open(_:_:options:permissions:)-10dcs>
/// <doc:FileDescriptor/open(_:_:options:permissions:retryOnInterrupt:)-2266j>
/// is a symbolic link,
/// then the link itself is opened instead of what it links to.
///
@@ -371,7 +386,7 @@ extension FileDescriptor {
}
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FileDescriptor.AccessMode
: CustomStringConvertible, CustomDebugStringConvertible
{
@@ -390,7 +405,7 @@ extension FileDescriptor.AccessMode
public var debugDescription: String { self.description }
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FileDescriptor.SeekOrigin
: CustomStringConvertible, CustomDebugStringConvertible
{
@@ -413,7 +428,7 @@ extension FileDescriptor.SeekOrigin
public var debugDescription: String { self.description }
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FileDescriptor.OpenOptions
: CustomStringConvertible, CustomDebugStringConvertible
{
@@ -459,3 +474,14 @@ extension FileDescriptor.OpenOptions
/// A textual representation of the open options, suitable for debugging.
public var debugDescription: String { self.description }
}
#if compiler(>=5.5) && canImport(_Concurrency)
// The decision on whether to make FileDescriptor Sendable or not
// is currently being discussed in https://github.com/apple/swift-system/pull/112
//@available(*, unavailable, message: "File descriptors are not completely thread-safe.")
//extension FileDescriptor: Sendable {}
extension FileDescriptor.AccessMode: Sendable {}
extension FileDescriptor.OpenOptions: Sendable {}
extension FileDescriptor.SeekOrigin: Sendable {}
#endif
+1 -4
View File
@@ -7,7 +7,7 @@
See https://swift.org/LICENSE.txt for license information
*/
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FileDescriptor {
/// Runs a closure and then closes the file descriptor, even if an error occurs.
///
@@ -46,9 +46,6 @@ extension FileDescriptor {
/// increments that position by the number of bytes written.
/// See also ``seek(offset:from:)``.
///
/// This method either writes the entire contents of `sequence`,
/// or throws an error if only part of the content was written.
///
/// If `sequence` doesn't implement
/// the <doc://com.apple.documentation/documentation/swift/sequence/3128824-withcontiguousstorageifavailable> method,
/// temporary space will be allocated as needed.
+146 -7
View File
@@ -7,7 +7,7 @@
See https://swift.org/LICENSE.txt for license information
*/
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FileDescriptor {
/// Opens or creates a file for reading or writing.
///
@@ -31,12 +31,70 @@ extension FileDescriptor {
permissions: FilePermissions? = nil,
retryOnInterrupt: Bool = true
) throws -> FileDescriptor {
try path.withPlatformString {
#if !os(Windows)
return try path.withCString {
try FileDescriptor.open(
$0, mode, options: options, permissions: permissions, retryOnInterrupt: retryOnInterrupt)
}
#else
return try path.withPlatformString {
try FileDescriptor.open(
$0, mode, options: options, permissions: permissions, retryOnInterrupt: retryOnInterrupt)
}
#endif
}
#if !os(Windows)
// On Darwin, `CInterop.PlatformChar` is less available than
// `FileDescriptor.open`, so we need to use `CChar` instead.
/// Opens or creates a file for reading or writing.
///
/// - Parameters:
/// - path: The location of the file to open.
/// - mode: The read and write access to use.
/// - options: The behavior for opening the file.
/// - permissions: The file permissions to use for created files.
/// - retryOnInterrupt: Whether to retry the open operation
/// if it throws ``Errno/interrupted``.
/// The default is `true`.
/// Pass `false` to try only once and throw an error upon interruption.
/// - Returns: A file descriptor for the open file
///
/// The corresponding C function is `open`.
@_alwaysEmitIntoClient
public static func open(
_ path: UnsafePointer<CChar>,
_ mode: FileDescriptor.AccessMode,
options: FileDescriptor.OpenOptions = FileDescriptor.OpenOptions(),
permissions: FilePermissions? = nil,
retryOnInterrupt: Bool = true
) throws -> FileDescriptor {
try FileDescriptor._open(
path, mode, options: options, permissions: permissions, retryOnInterrupt: retryOnInterrupt
).get()
}
@usableFromInline
internal static func _open(
_ path: UnsafePointer<CChar>,
_ mode: FileDescriptor.AccessMode,
options: FileDescriptor.OpenOptions,
permissions: FilePermissions?,
retryOnInterrupt: Bool
) -> Result<FileDescriptor, Errno> {
let oFlag = mode.rawValue | options.rawValue
let descOrError: Result<CInt, Errno> = valueOrErrno(retryOnInterrupt: retryOnInterrupt) {
if let permissions = permissions {
return system_open(path, oFlag, permissions.rawValue)
}
precondition(!options.contains(.create),
"Create must be given permissions")
return system_open(path, oFlag)
}
return descOrError.map { FileDescriptor(rawValue: $0) }
}
#else
/// Opens or creates a file for reading or writing.
///
/// - Parameters:
@@ -83,6 +141,7 @@ extension FileDescriptor {
}
return descOrError.map { FileDescriptor(rawValue: $0) }
}
#endif
/// Deletes a file descriptor.
///
@@ -144,7 +203,7 @@ extension FileDescriptor {
/// Pass `false` to try only once and throw an error upon interruption.
/// - Returns: The number of bytes that were read.
///
/// The <doc://com.apple.documentation/documentation/swift/unsafemutablerawbufferpointer/3019191-count> property of `buffer`
/// The <doc://com.apple.documentation/documentation/swift/unsafemutablerawbufferpointer/count-95usp> property of `buffer`
/// determines the maximum number of bytes that are read into that buffer.
///
/// After reading,
@@ -182,10 +241,10 @@ extension FileDescriptor {
/// Pass `false` to try only once and throw an error upon interruption.
/// - Returns: The number of bytes that were read.
///
/// The <doc://com.apple.documentation/documentation/swift/unsafemutablerawbufferpointer/3019191-count> property of `buffer`
/// The <doc://com.apple.documentation/documentation/swift/unsafemutablerawbufferpointer/count-95usp> property of `buffer`
/// determines the maximum number of bytes that are read into that buffer.
///
/// Unlike <doc:System/FileDescriptor/read(into:retryOnInterrupt:)>,
/// Unlike <doc:FileDescriptor/read(into:retryOnInterrupt:)>,
/// this method leaves the file's existing offset unchanged.
///
/// The corresponding C function is `pread`.
@@ -308,7 +367,10 @@ extension FileDescriptor {
buffer,
retryOnInterrupt: retryOnInterrupt)
}
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FileDescriptor {
/// Duplicate this file descriptor and return the newly created copy.
///
/// - Parameters:
@@ -337,7 +399,7 @@ extension FileDescriptor {
///
/// The corresponding C functions are `dup` and `dup2`.
@_alwaysEmitIntoClient
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
public func duplicate(
as target: FileDescriptor? = nil,
retryOnInterrupt: Bool = true
@@ -345,7 +407,7 @@ extension FileDescriptor {
try _duplicate(as: target, retryOnInterrupt: retryOnInterrupt).get()
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
@usableFromInline
internal func _duplicate(
as target: FileDescriptor?,
@@ -371,3 +433,80 @@ extension FileDescriptor {
fatalError("Not implemented")
}
}
#if !os(Windows)
@available(/*System 1.1.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
extension FileDescriptor {
/// Create a pipe, a unidirectional data channel which can be used for interprocess communication.
///
/// - Returns: The pair of file descriptors.
///
/// The corresponding C function is `pipe`.
@_alwaysEmitIntoClient
@available(/*System 1.1.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
public static func pipe() throws -> (readEnd: FileDescriptor, writeEnd: FileDescriptor) {
try _pipe().get()
}
@available(/*System 1.1.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
@usableFromInline
internal static func _pipe() -> Result<(readEnd: FileDescriptor, writeEnd: FileDescriptor), Errno> {
var fds: (Int32, Int32) = (-1, -1)
return withUnsafeMutablePointer(to: &fds) { pointer in
pointer.withMemoryRebound(to: Int32.self, capacity: 2) { fds in
valueOrErrno(retryOnInterrupt: false) {
system_pipe(fds)
}.map { _ in (.init(rawValue: fds[0]), .init(rawValue: fds[1])) }
}
}
}
}
#endif
#if !os(Windows)
@available(/*System 1.2.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
extension FileDescriptor {
/// Truncate or extend the file referenced by this file descriptor.
///
/// - Parameters:
/// - newSize: The length in bytes to resize the file to.
/// - retryOnInterrupt: Whether to retry the write operation
/// if it throws ``Errno/interrupted``. The default is `true`.
/// Pass `false` to try only once and throw an error upon interruption.
///
/// The file referenced by this file descriptor will by truncated (or extended) to `newSize`.
///
/// If the current size of the file exceeds `newSize`, any extra data is discarded. If the current
/// size of the file is smaller than `newSize`, the file is extended and filled with zeros to the
/// provided size.
///
/// This function requires that the file has been opened for writing.
///
/// - Note: This function does not modify the current offset for any open file descriptors
/// associated with the file.
///
/// The corresponding C function is `ftruncate`.
@available(/*System 1.2.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
@_alwaysEmitIntoClient
public func resize(
to newSize: Int64,
retryOnInterrupt: Bool = true
) throws {
try _resize(
to: newSize,
retryOnInterrupt: retryOnInterrupt
).get()
}
@available(/*System 1.2.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
@usableFromInline
internal func _resize(
to newSize: Int64,
retryOnInterrupt: Bool
) -> Result<(), Errno> {
nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
system_ftruncate(self.rawValue, _COffT(newSize))
}
}
}
#endif
+10 -8
View File
@@ -16,7 +16,7 @@
/// encoding.
///
/// On construction, `FilePath` will normalize separators by removing
/// reduncant intermediary separators and stripping any trailing separators.
/// redundant intermediary separators and stripping any trailing separators.
/// On Windows, `FilePath` will also normalize forward slashes `/` into
/// backslashes `\`, as preferred by the platform.
///
@@ -28,11 +28,8 @@
/// let fd = try FileDescriptor.open(path, .writeOnly, options: .append)
/// try fd.closeAfter { try fd.writeAll(message.utf8) }
///
/// TODO(docs): Section on all the new syntactic operations, lexical normalization, decomposition,
/// components, etc.
///
/// File paths conform to the
/// and <doc://com.apple.documentation/documentation/swift/equatable>
/// <doc://com.apple.documentation/documentation/swift/equatable>
/// and <doc://com.apple.documentation/documentation/swift/hashable> protocols
/// by performing the protocols' operations on their raw byte contents.
/// This conformance allows file paths to be used,
@@ -40,8 +37,10 @@
/// However, the rules for path equivalence
/// are file-system–specific and have additional considerations
/// like case insensitivity, Unicode normalization, and symbolic links.
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
public struct FilePath {
// TODO(docs): Section on all the new syntactic operations, lexical normalization, decomposition,
// components, etc.
internal var _storage: SystemString
/// Creates an empty, null-terminated path.
@@ -60,12 +59,15 @@ public struct FilePath {
}
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath {
/// The length of the file path, excluding the null terminator.
public var length: Int { _storage.length }
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath: Hashable, Codable {}
#if compiler(>=5.5) && canImport(_Concurrency)
extension FilePath: Sendable {}
#endif
@@ -9,7 +9,7 @@
// MARK: - API
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
/// A bidirectional, range replaceable collection of the non-root components
/// that make up a file path.
@@ -28,7 +28,6 @@ extension FilePath {
///
/// path.components.removeAll { $0.kind == .currentDirectory }
/// // path is "/home/username/bin/scripts/tree"
///
public struct ComponentView {
internal var _path: FilePath
internal var _start: SystemString.Index
@@ -40,7 +39,7 @@ extension FilePath {
}
}
#if SYSTEM_PACKAGE
#if SYSTEM_PACKAGE // Workaround for a __consuming getter bug in Swift 5.3.3
/// View the non-root components that make up this path.
public var components: ComponentView {
get { ComponentView(self) }
@@ -89,7 +88,7 @@ extension FilePath {
#endif
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.ComponentView: BidirectionalCollection {
public typealias Element = FilePath.Component
public struct Index: Comparable, Hashable {
@@ -123,7 +122,7 @@ extension FilePath.ComponentView: BidirectionalCollection {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.ComponentView: RangeReplaceableCollection {
public init() {
self.init(FilePath())
@@ -173,7 +172,7 @@ extension FilePath.ComponentView: RangeReplaceableCollection {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
/// Create a file path from a root and a collection of components.
public init<C: Collection>(
@@ -202,6 +201,7 @@ extension FilePath {
// MARK: - Internals
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.ComponentView: _PathSlice {
internal var _range: Range<SystemString.Index> {
_start ..< _path._storage.endIndex
@@ -214,6 +214,7 @@ extension FilePath.ComponentView: _PathSlice {
// MARK: - Invariants
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.ComponentView {
internal func _invariantCheck() {
#if DEBUG
@@ -238,3 +239,8 @@ extension FilePath.ComponentView {
#endif // DEBUG
}
}
#if compiler(>=5.5) && canImport(_Concurrency)
extension FilePath.ComponentView: Sendable {}
extension FilePath.ComponentView.Index: Sendable {}
#endif
@@ -9,7 +9,7 @@
// MARK: - API
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
/// Represents a root of a file path.
///
@@ -54,7 +54,6 @@ extension FilePath {
/// file.kind == .regular // true
/// file.extension // "txt"
/// path.append(file) // path is "/tmp/foo.txt"
///
public struct Component {
internal var _path: FilePath
internal var _range: Range<SystemString.Index>
@@ -73,7 +72,7 @@ extension FilePath {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Component {
/// Whether a component is a regular file or directory name, or a special
@@ -98,6 +97,7 @@ extension FilePath.Component {
}
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Root {
// TODO: Windows analysis APIs
}
@@ -183,15 +183,18 @@ extension _PathSlice {
internal var _storage: SystemString { _path._storage }
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Component: _PathSlice {
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Root: _PathSlice {
internal var _range: Range<SystemString.Index> {
(..<_rootEnd).relative(to: _path._storage)
}
}
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath: _PlatformStringable {
@usableFromInline
func _withPlatformString<Result>(_ body: (UnsafePointer<CInterop.PlatformChar>) throws -> Result) rethrows -> Result {
try _storage.withPlatformString(body)
}
@@ -202,6 +205,7 @@ extension FilePath: _PlatformStringable {
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Component {
// The index of the `.` denoting an extension
internal func _extensionIndex() -> SystemString.Index? {
@@ -230,6 +234,7 @@ internal func _makeExtension(_ ext: String) -> SystemString {
return result
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Component {
internal init?(_ str: SystemString) {
// FIXME: explicit null root? Or something else?
@@ -242,6 +247,7 @@ extension FilePath.Component {
}
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Root {
internal init?(_ str: SystemString) {
// FIXME: explicit null root? Or something else?
@@ -256,6 +262,7 @@ extension FilePath.Root {
// MARK: - Invariants
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Component {
// TODO: ensure this all gets easily optimized away in release...
internal func _invariantCheck() {
@@ -267,6 +274,8 @@ extension FilePath.Component {
#endif // DEBUG
}
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Root {
internal func _invariantCheck() {
#if DEBUG
@@ -276,3 +285,9 @@ extension FilePath.Root {
#endif
}
}
#if compiler(>=5.5) && canImport(_Concurrency)
extension FilePath.Root: Sendable {}
extension FilePath.Component: Sendable {}
extension FilePath.Component.Kind: Sendable {}
#endif
@@ -111,6 +111,7 @@ extension SystemString {
}
}
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath {
internal mutating func _removeTrailingSeparator() {
_storage._removeTrailingSeparator()
@@ -191,6 +192,7 @@ extension SystemString {
}
}
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath {
internal var _relativeStart: SystemString.Index {
_storage._relativePathStart
@@ -202,6 +204,7 @@ extension FilePath {
// Parse separators
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath {
internal typealias _Index = SystemString.Index
@@ -265,6 +268,7 @@ extension FilePath {
}
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.ComponentView {
// TODO: Store this...
internal var _relativeStart: SystemString.Index {
@@ -289,6 +293,7 @@ extension SystemString {
}
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Root {
// Asserting self is a root, returns whether this is an
// absolute root.
@@ -313,6 +318,7 @@ extension FilePath.Root {
}
}
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath {
internal var _portableDescription: String {
guard _windowsPaths else { return description }
@@ -331,6 +337,7 @@ internal var _windowsPaths: Bool {
#endif
}
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath {
// Whether we should add a separator when doing an append
internal var _needsSeparatorForAppend: Bool {
@@ -358,6 +365,7 @@ extension FilePath {
}
// MARK: - Invariants
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath {
internal func _invariantCheck() {
#if DEBUG
+209 -26
View File
@@ -9,7 +9,7 @@
// MARK: - Platform string
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
/// Creates a file path by copying bytes from a null-terminated platform
/// string.
@@ -20,6 +20,56 @@ extension FilePath {
self.init(_platformString: platformString)
}
/// Creates a file path by copying bytes from a null-terminated platform
/// string.
///
/// - Note It is a precondition that `platformString` must be null-terminated.
/// The absence of a null byte will trigger a runtime error.
///
/// - Parameter platformString: A null-terminated platform string.
@inlinable
@_alwaysEmitIntoClient
public init(platformString: [CInterop.PlatformChar]) {
guard let _ = platformString.firstIndex(of: 0) else {
fatalError(
"input of FilePath.init(platformString:) must be null-terminated"
)
}
self = platformString.withUnsafeBufferPointer {
FilePath(platformString: $0.baseAddress!)
}
}
@inlinable
@_alwaysEmitIntoClient
@available(*, deprecated, message: "Use FilePath.init(_ scalar: Unicode.Scalar)")
public init(platformString: inout CInterop.PlatformChar) {
guard platformString == 0 else {
fatalError(
"input of FilePath.init(platformString:) must be null-terminated"
)
}
self = FilePath()
}
@inlinable
@_alwaysEmitIntoClient
@available(*, deprecated, message: "Use FilePath(_: String) to create a path from a String")
public init(platformString: String) {
if let nullLoc = platformString.firstIndex(of: "\0") {
self = FilePath(String(platformString[..<nullLoc]))
} else {
self = FilePath(platformString)
}
}
#if !os(Windows)
// Note: This function should have been opaque, but it shipped as
// `@_alwaysEmitIntoClient` in macOS 12/iOS 15, and now it is stuck
// this way forever. (Or until the language provides a way for us
// to declare separate availability for a function's exported symbol
// and its inlinable body.)
/// Calls the given closure with a pointer to the contents of the file path,
/// represented as a null-terminated platform string.
///
@@ -36,16 +86,30 @@ extension FilePath {
public func withPlatformString<Result>(
_ body: (UnsafePointer<CInterop.PlatformChar>) throws -> Result
) rethrows -> Result {
// For backwards deployment, call withCString if available.
#if !os(Windows)
return try withCString(body)
#else
return try _withPlatformString(body)
#endif
}
#else
/// Calls the given closure with a pointer to the contents of the file path,
/// represented as a null-terminated platform string.
///
/// - Parameter body: A closure with a pointer parameter
/// that points to a null-terminated platform string.
/// If `body` has a return value,
/// that value is also used as the return value for this method.
/// - Returns: The return value, if any, of the `body` closure parameter.
///
/// The pointer passed as an argument to `body` is valid
/// only during the execution of this method.
/// Don't try to store the pointer for later use.
public func withPlatformString<Result>(
_ body: (UnsafePointer<CInterop.PlatformChar>) throws -> Result
) rethrows -> Result {
return try _withPlatformString(body)
}
#endif
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Component {
/// Creates a file path component by copying bytes from a null-terminated
/// platform string.
@@ -55,11 +119,63 @@ extension FilePath.Component {
///
/// - Parameter platformString: A pointer to a null-terminated platform
/// string.
///
public init?(platformString: UnsafePointer<CInterop.PlatformChar>) {
self.init(_platformString: platformString)
}
/// Creates a file path component by copying bytes from a null-terminated
/// platform string. It is a precondition that a null byte indicates the end of
/// the string. The absence of a null byte will trigger a runtime error.
///
/// Returns `nil` if `platformString` is empty, is a root, or has more than
/// one component in it.
///
/// - Note It is a precondition that `platformString` must be null-terminated.
/// The absence of a null byte will trigger a runtime error.
///
/// - Parameter platformString: A null-terminated platform string.
@inlinable
@_alwaysEmitIntoClient
public init?(platformString: [CInterop.PlatformChar]) {
guard let _ = platformString.firstIndex(of: 0) else {
fatalError(
"input of FilePath.Component.init?(platformString:) must be null-terminated"
)
}
guard let component = platformString.withUnsafeBufferPointer({
FilePath.Component(platformString: $0.baseAddress!)
}) else {
return nil
}
self = component
}
@inlinable
@_alwaysEmitIntoClient
@available(*, deprecated, message: "Use FilePath.Component.init(_ scalar: Unicode.Scalar)")
public init?(platformString: inout CInterop.PlatformChar) {
guard platformString == 0 else {
fatalError(
"input of FilePath.Component.init?(platformString:) must be null-terminated"
)
}
return nil
}
@inlinable
@_alwaysEmitIntoClient
@available(*, deprecated, message: "Use FilePath.Component.init(_: String)")
public init?(platformString: String) {
let string: String
if let nullLoc = platformString.firstIndex(of: "\0") {
string = String(platformString[..<nullLoc])
} else {
string = platformString
}
guard let component = FilePath.Component(string) else { return nil }
self = component
}
/// Calls the given closure with a pointer to the contents of the file path
/// component, represented as a null-terminated platform string.
///
@@ -82,7 +198,7 @@ extension FilePath.Component {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Root {
/// Creates a file path root by copying bytes from a null-terminated platform
/// string.
@@ -91,11 +207,62 @@ extension FilePath.Root {
///
/// - Parameter platformString: A pointer to a null-terminated platform
/// string.
///
public init?(platformString: UnsafePointer<CInterop.PlatformChar>) {
self.init(_platformString: platformString)
}
/// Creates a file path root by copying bytes from a null-terminated platform
/// string. It is a precondition that a null byte indicates the end of
/// the string. The absence of a null byte will trigger a runtime error.
///
/// Returns `nil` if `platformString` is empty or is not a root.
///
/// - Note It is a precondition that `platformString` must be null-terminated.
/// The absence of a null byte will trigger a runtime error.
///
/// - Parameter platformString: A null-terminated platform string.
@inlinable
@_alwaysEmitIntoClient
public init?(platformString: [CInterop.PlatformChar]) {
guard let _ = platformString.firstIndex(of: 0) else {
fatalError(
"input of FilePath.Root.init?(platformString:) must be null-terminated"
)
}
guard let component = platformString.withUnsafeBufferPointer({
FilePath.Root(platformString: $0.baseAddress!)
}) else {
return nil
}
self = component
}
@inlinable
@_alwaysEmitIntoClient
@available(*, deprecated, message: "Use FilePath.Root.init(_ scalar: Unicode.Scalar)")
public init?(platformString: inout CInterop.PlatformChar) {
guard platformString == 0 else {
fatalError(
"input of FilePath.Root.init?(platformString:) must be null-terminated"
)
}
return nil
}
@inlinable
@_alwaysEmitIntoClient
@available(*, deprecated, message: "Use FilePath.Root.init(_: String)")
public init?(platformString: String) {
let string: String
if let nullLoc = platformString.firstIndex(of: "\0") {
string = String(platformString[..<nullLoc])
} else {
string = platformString
}
guard let root = FilePath.Root(string) else { return nil }
self = root
}
/// Calls the given closure with a pointer to the contents of the file path
/// root, represented as a null-terminated platform string.
///
@@ -120,7 +287,7 @@ extension FilePath.Root {
// MARK: - String literals
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath: ExpressibleByStringLiteral {
/// Creates a file path from a string literal.
///
@@ -139,7 +306,7 @@ extension FilePath: ExpressibleByStringLiteral {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Component: ExpressibleByStringLiteral {
/// Create a file path component from a string literal.
///
@@ -148,7 +315,7 @@ extension FilePath.Component: ExpressibleByStringLiteral {
public init(stringLiteral: String) {
guard let s = FilePath.Component(stringLiteral) else {
// TODO: static assert
preconditionFailure("""
fatalError("""
FilePath.Component must be created from exactly one non-root component
""")
}
@@ -164,7 +331,7 @@ extension FilePath.Component: ExpressibleByStringLiteral {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Root: ExpressibleByStringLiteral {
/// Create a file path root from a string literal.
///
@@ -172,7 +339,7 @@ extension FilePath.Root: ExpressibleByStringLiteral {
public init(stringLiteral: String) {
guard let s = FilePath.Root(stringLiteral) else {
// TODO: static assert
preconditionFailure("""
fatalError("""
FilePath.Root must be created from a root
""")
}
@@ -189,7 +356,7 @@ extension FilePath.Root: ExpressibleByStringLiteral {
// MARK: - Printing and dumping
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath: CustomStringConvertible, CustomDebugStringConvertible {
/// A textual representation of the file path.
///
@@ -205,7 +372,7 @@ extension FilePath: CustomStringConvertible, CustomDebugStringConvertible {
public var debugDescription: String { description.debugDescription }
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Component: CustomStringConvertible, CustomDebugStringConvertible {
/// A textual representation of the path component.
@@ -222,7 +389,7 @@ extension FilePath.Component: CustomStringConvertible, CustomDebugStringConverti
public var debugDescription: String { description.debugDescription }
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Root: CustomStringConvertible, CustomDebugStringConvertible {
/// A textual representation of the path root.
@@ -242,7 +409,7 @@ extension FilePath.Root: CustomStringConvertible, CustomDebugStringConvertible {
// MARK: - Convenience helpers
// Convenience helpers
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
/// Creates a string by interpreting the path’s content as UTF-8 on Unix
/// and UTF-16 on Windows.
@@ -253,7 +420,7 @@ extension FilePath {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Component {
/// Creates a string by interpreting the component’s content as UTF-8 on Unix
/// and UTF-16 on Windows.
@@ -264,7 +431,7 @@ extension FilePath.Component {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Root {
/// On Unix, this returns `"/"`.
///
@@ -278,7 +445,7 @@ extension FilePath.Root {
// MARK: - Decoding and validating
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension String {
/// Creates a string by interpreting the file path's content as UTF-8 on Unix
/// and UTF-16 on Windows.
@@ -308,7 +475,7 @@ extension String {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension String {
/// Creates a string by interpreting the path component's content as UTF-8 on
/// Unix and UTF-16 on Windows.
@@ -338,7 +505,7 @@ extension String {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension String {
/// On Unix, creates the string `"/"`
///
@@ -391,7 +558,7 @@ extension String {
// MARK: - Deprecations
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension String {
@available(*, deprecated, renamed: "init(decoding:)")
public init(_ path: FilePath) { self.init(decoding: path) }
@@ -401,14 +568,30 @@ extension String {
}
#if !os(Windows)
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePath {
/// For backwards compatibility only. This initializer is equivalent to
/// the preferred `FilePath(platformString:)`.
@available(*, deprecated, renamed: "init(platformString:)")
public init(cString: UnsafePointer<CChar>) {
self.init(platformString: cString)
}
@available(*, deprecated, renamed: "init(platformString:)")
public init(cString: [CChar]) {
self.init(platformString: cString)
}
@available(*, deprecated, renamed: "init(platformString:)")
public init(cString: inout CChar) {
self.init(platformString: &cString)
}
@available(*, deprecated, renamed: "init(platformString:)")
public init(cString: String) {
self.init(platformString: cString)
}
/// For backwards compatibility only. This function is equivalent to
/// the preferred `withPlatformString`.
public func withCString<Result>(
+30 -58
View File
@@ -9,7 +9,7 @@
// MARK: - Query API
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
/// Returns true if this path uniquely identifies the location of
/// a file without reference to an additional starting location.
@@ -52,6 +52,8 @@ extension FilePath {
/// * `\Users`
public var isRelative: Bool { !isAbsolute }
// TODO(Windows docs): examples with roots, such as whether `\foo\bar`
// starts with `C:\foo`
/// Returns whether `other` is a prefix of `self`, only considering
/// whole path components.
///
@@ -63,16 +65,14 @@ extension FilePath {
/// path.starts(with: "/usr/bin/ls") // true
/// path.starts(with: "/usr/bin/ls///") // true
/// path.starts(with: "/us") // false
///
/// TODO(Windows docs): examples with roots, such as whether `\foo\bar`
/// starts with `C:\foo`
///
public func starts(with other: FilePath) -> Bool {
guard !other.isEmpty else { return true }
return self.root == other.root && components.starts(
with: other.components)
}
// TODO(Windows docs): examples with roots, such as whether `C:\foo\bar`
// ends with `C:bar`
/// Returns whether `other` is a suffix of `self`, only considering
/// whole path components.
///
@@ -84,10 +84,6 @@ extension FilePath {
/// path.ends(with: "usr/bin/ls") // true
/// path.ends(with: "/usr/bin/ls///") // true
/// path.ends(with: "/ls") // false
///
/// TODO(Windows docs): examples with roots, such as whether `C:\foo\bar`
/// ends with `C:bar`
///
public func ends(with other: FilePath) -> Bool {
if other.root != nil {
// TODO: anything tricky here for Windows?
@@ -103,7 +99,7 @@ extension FilePath {
}
// MARK: - Decompose a path
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
/// Returns the root of a path if there is one, otherwise `nil`.
///
@@ -147,7 +143,6 @@ extension FilePath {
/// path.root = nil // path is #"foo\bar"#
/// path.root = "C:" // path is #"C:foo\bar"#
/// path.root = #"C:\"# // path is #"C:\foo\bar"#
///
public var root: FilePath.Root? {
get {
guard _hasRoot else { return nil }
@@ -180,7 +175,6 @@ extension FilePath {
/// * `\\?\device\folder\file.exe => folder\file.exe`
/// * `\\server\share\file => file`
/// * `\ => ""`
///
public __consuming func removingRoot() -> FilePath {
var copy = self
copy.root = nil
@@ -188,7 +182,7 @@ extension FilePath {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
/// Returns the final component of the path.
/// Returns `nil` if the path is empty or only contains a root.
@@ -211,7 +205,6 @@ extension FilePath {
/// * `\\?\UNC\server\share\bar.exe => bar.exe`
/// * `\\server\share => nil`
/// * `\\?\UNC\server\share\ => nil`
///
public var lastComponent: Component? { components.last }
/// Creates a new path with everything up to but not including
@@ -249,7 +242,6 @@ extension FilePath {
/// path.removeLastComponent() == true // path is "/usr"
/// path.removeLastComponent() == true // path is "/"
/// path.removeLastComponent() == false // path is "/"
///
@discardableResult
public mutating func removeLastComponent() -> Bool {
defer { _invariantCheck() }
@@ -260,7 +252,7 @@ extension FilePath {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath.Component {
/// The extension of this file or directory component.
///
@@ -273,7 +265,6 @@ extension FilePath.Component {
/// * `Foo.app => app`
/// * `.hidden => nil`
/// * `.. => nil`
///
public var `extension`: String? {
guard let range = _extensionRange() else { return nil }
return _slice[range].string
@@ -287,13 +278,12 @@ extension FilePath.Component {
/// * `Foo.app => Foo`
/// * `.hidden => .hidden`
/// * `.. => ..`
///
public var stem: String {
_slice[_stemRange()].string
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
/// The extension of the file or directory last component.
@@ -324,7 +314,6 @@ extension FilePath {
/// path.extension = "o" // path is "/tmp/file.o"
/// path.extension = nil // path is "/tmp/file"
/// path.extension = "" // path is "/tmp/file."
///
public var `extension`: String? {
get { lastComponent?.extension }
set {
@@ -360,7 +349,7 @@ extension FilePath {
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
/// Whether the path is in lexical-normal form, that is `.` and `..`
/// components have been collapsed lexically (i.e. without following
@@ -441,10 +430,11 @@ extension FilePath {
}
// Modification and concatenation API
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
// TODO(Windows docs): example with roots
/// If `prefix` is a prefix of `self`, removes it and returns `true`.
/// Otherwise returns `false`.
/// Otherwise returns `false`.
///
/// Example:
///
@@ -452,9 +442,6 @@ extension FilePath {
/// path.removePrefix("/usr/bin") // false
/// path.removePrefix("/us") // false
/// path.removePrefix("/usr/local") // true, path is "bin"
///
/// TODO(Windows docs): example with roots
///
public mutating func removePrefix(_ prefix: FilePath) -> Bool {
defer { _invariantCheck() }
// FIXME: Should Windows have more nuanced semantics?
@@ -465,6 +452,7 @@ extension FilePath {
return true
}
// TODO(Windows docs): example with roots
/// Append a `component` on to the end of this path.
///
/// Example:
@@ -475,14 +463,12 @@ extension FilePath {
/// path.append(comp)
/// }
/// // path is "/tmp/foo/bar/../baz"
///
/// TODO(Windows docs): example with roots
///
public mutating func append(_ component: __owned FilePath.Component) {
defer { _invariantCheck() }
_append(unchecked: component._slice)
}
// TODO(Windows docs): example with roots
/// Append `components` on to the end of this path.
///
/// Example:
@@ -491,9 +477,6 @@ extension FilePath {
/// path.append(["usr", "local"]) // path is "/usr/local"
/// let otherPath: FilePath = "/bin/ls"
/// path.append(otherPath.components) // path is "/usr/local/bin/ls"
///
/// TODO(Windows docs): example with roots
///
public mutating func append<C: Collection>(
_ components: __owned C
) where C.Element == FilePath.Component {
@@ -503,19 +486,18 @@ extension FilePath {
}
}
// TODO(Windows docs): example with roots, should we rephrase this "spurious
// roots"?
/// Append the contents of `other`, ignoring any spurious leading separators.
///
/// A leading separator is spurious if `self` is non-empty.
///
/// Example:
/// var path: FilePath = ""
/// path.append("/var/www/website") // "/var/www/website"
/// path.append("static/assets") // "/var/www/website/static/assets"
/// path.append("/main.css") // "/var/www/website/static/assets/main.css"
///
/// TODO(Windows docs): example with roots, should we rephrase this "spurious
/// roots"?
///
/// var path: FilePath = ""
/// path.append("/var/www/website") // "/var/www/website"
/// path.append("static/assets") // "/var/www/website/static/assets"
/// path.append("/main.css") // "/var/www/website/static/assets/main.css"
public mutating func append(_ other: __owned String) {
defer { _invariantCheck() }
guard !other.utf8.isEmpty else { return }
@@ -527,20 +509,16 @@ extension FilePath {
_append(unchecked: otherPath._storage[otherPath._relativeStart...])
}
// TODO(Windows docs): example with roots
/// Non-mutating version of `append(_:Component)`.
///
/// TODO(Windows docs): example with roots
///
public __consuming func appending(_ other: __owned Component) -> FilePath {
var copy = self
copy.append(other)
return copy
}
// TODO(Windows docs): example with roots
/// Non-mutating version of `append(_:C)`.
///
/// TODO(Windows docs): example with roots
///
public __consuming func appending<C: Collection>(
_ components: __owned C
) -> FilePath where C.Element == FilePath.Component {
@@ -549,16 +527,16 @@ extension FilePath {
return copy
}
// TODO(Windows docs): example with roots
/// Non-mutating version of `append(_:String)`.
///
/// TODO(Windows docs): example with roots
///
public __consuming func appending(_ other: __owned String) -> FilePath {
var copy = self
copy.append(other)
return copy
}
// TODO(Windows docs): examples and docs with roots, update/generalize doc
// comment
/// If `other` does not have a root, append each component of `other`. If
/// `other` has a root, replaces `self` with other.
///
@@ -572,24 +550,18 @@ extension FilePath {
/// var path: FilePath = "/tmp"
/// path.push("dir/file.txt") // path is "/tmp/dir/file.txt"
/// path.push("/bin") // path is "/bin"
///
/// TODO(Windows docs): examples and docs with roots, update/generalize doc
/// comment
///
public mutating func push(_ other: __owned FilePath) {
defer { _invariantCheck() }
guard other.root == nil else {
self = other
return
}
/// FIXME: Windows drive-relative roots, etc?
// FIXME: Windows drive-relative roots, etc?
_append(unchecked: other._storage[...])
}
/// Non-mutating version of `push()`
///
/// TODO(Windows docs): examples and docs with roots
///
// TODO(Windows docs): examples and docs with roots
/// Non-mutating version of `push()`.
public __consuming func pushing(_ other: __owned FilePath) -> FilePath {
var copy = self
copy.push(other)
@@ -611,7 +583,7 @@ extension FilePath {
}
// MARK - Renamed
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
@available(*, unavailable, renamed: "removingLastComponent()")
public var dirname: FilePath { removingLastComponent() }
@@ -150,21 +150,19 @@ internal struct WindowsRootInfo {
/// * Omitted volume from other forms: `\\.\`, `\\.\UNC\server\\`, `\\server\\`
case empty
// TODO: NT paths? Admin paths using `$`?
/// A specified drive.
///
/// * Traditional disk: `C:\`, `C:`
/// * Device disk: `\\.\C:\`, `\\?\C:\`
/// * UNC: `\\server\e:\`, `\\?\UNC\server\e:\`
///
/// TODO: NT paths? Admin paths using `$`?
case drive(Character)
// TODO: GUID type?
/// A volume with a GUID in a non-traditional path
///
/// * UNC: `\\host\Volume{0000-...}\`, `\\.\UNC\host\Volume{0000-...}\`
/// * Device roots: `\\.\Volume{0000-...}\`, `\\?\Volume{000-...}\`
///
/// TODO: GUID type?
case guid(String)
// TODO: Legacy DOS devices, such as COM1?
+9 -5
View File
@@ -17,18 +17,18 @@
/// let perms = FilePermissions(rawValue: 0o644)
/// perms == [.ownerReadWrite, .groupRead, .otherRead] // true
@frozen
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
public struct FilePermissions: OptionSet, Hashable, Codable {
/// The raw C file permissions.
@_alwaysEmitIntoClient
public let rawValue: CInterop.Mode
public let rawValue: CModeT
/// Create a strongly-typed file permission from a raw C value.
@_alwaysEmitIntoClient
public init(rawValue: CInterop.Mode) { self.rawValue = rawValue }
public init(rawValue: CModeT) { self.rawValue = rawValue }
@_alwaysEmitIntoClient
private init(_ raw: CInterop.Mode) { self.init(rawValue: raw) }
private init(_ raw: CModeT) { self.init(rawValue: raw) }
/// Indicates that other users have read-only permission.
@_alwaysEmitIntoClient
@@ -135,7 +135,7 @@ public struct FilePermissions: OptionSet, Hashable, Codable {
public static var saveText: FilePermissions { FilePermissions(0o1000) }
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
extension FilePermissions
: CustomStringConvertible, CustomDebugStringConvertible
{
@@ -175,3 +175,7 @@ extension FilePermissions
/// A textual representation of the file permissions, suitable for debugging.
public var debugDescription: String { self.description }
}
#if compiler(>=5.5) && canImport(_Concurrency)
extension FilePermissions: Sendable {}
#endif
+29
View File
@@ -0,0 +1,29 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
extension String {
internal init(
_unsafeUninitializedCapacity capacity: Int,
initializingUTF8With body: (UnsafeMutableBufferPointer<UInt8>) throws -> Int
) rethrows {
if #available(macOS 11, iOS 14.0, watchOS 7.0, tvOS 14.0, *) {
self = try String(
unsafeUninitializedCapacity: capacity,
initializingUTF8With: body)
return
}
let array = try Array<UInt8>(
unsafeUninitializedCapacity: capacity
) { buffer, count in
count = try body(buffer)
}
self = String(decoding: array, as: UTF8.self)
}
}
+18 -11
View File
@@ -1,23 +1,16 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
// MARK: - Public typealiases
/// The C `mode_t` type.
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(*, deprecated, renamed: "CInterop.Mode")
public typealias CModeT = CInterop.Mode
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
import Darwin
#elseif os(Linux) || os(FreeBSD) || os(Android)
import CSystem
#elseif os(Linux) || os(FreeBSD) || os(OpenBSD) || os(Android)
@_implementationOnly import CSystem
import Glibc
#elseif os(Windows)
import CSystem
@@ -26,8 +19,22 @@ import ucrt
#error("Unsupported Platform")
#endif
// MARK: - Public typealiases
// FIXME: `CModeT` ought to be deprecated and replaced with `CInterop.Mode`
// if/when the compiler becomes less strict about availability checking
// of "namespaced" typealiases. (rdar://81722893)
#if os(Windows)
/// The C `mode_t` type.
public typealias CModeT = CInt
#else
/// The C `mode_t` type.
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
public typealias CModeT = mode_t
#endif
/// A namespace for C and platform types
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
public enum CInterop {
#if os(Windows)
public typealias Mode = CInt
+6 -5
View File
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
@@ -13,8 +13,7 @@
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
import Darwin
#elseif os(Linux) || os(FreeBSD) || os(Android)
import CSystem
#elseif os(Linux) || os(FreeBSD) || os(OpenBSD) || os(Android)
import Glibc
#elseif os(Windows)
import CSystem
@@ -393,6 +392,7 @@ internal var _ENOATTR: CInt { ENOATTR }
@_alwaysEmitIntoClient
internal var _EBADMSG: CInt { EBADMSG }
#if !os(OpenBSD)
@_alwaysEmitIntoClient
internal var _EMULTIHOP: CInt { EMULTIHOP }
@@ -407,13 +407,16 @@ internal var _ENOSR: CInt { ENOSR }
@_alwaysEmitIntoClient
internal var _ENOSTR: CInt { ENOSTR }
#endif
@_alwaysEmitIntoClient
internal var _EPROTO: CInt { EPROTO }
#if !os(OpenBSD)
@_alwaysEmitIntoClient
internal var _ETIME: CInt { ETIME }
#endif
#endif
@_alwaysEmitIntoClient
internal var _EOPNOTSUPP: CInt { EOPNOTSUPP }
@@ -498,7 +501,6 @@ internal var _O_EVTONLY: CInt { O_EVTONLY }
@_alwaysEmitIntoClient
internal var _O_NOCTTY: CInt { O_NOCTTY }
// TODO: API?
@_alwaysEmitIntoClient
internal var _O_DIRECTORY: CInt { O_DIRECTORY }
#endif
@@ -529,4 +531,3 @@ internal var _SEEK_HOLE: CInt { SEEK_HOLE }
@_alwaysEmitIntoClient
internal var _SEEK_DATA: CInt { SEEK_DATA }
#endif
+17 -4
View File
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
@@ -14,8 +14,8 @@
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
import Darwin
#elseif os(Linux) || os(FreeBSD) || os(Android)
import CSystem
#elseif os(Linux) || os(FreeBSD) || os(OpenBSD) || os(Android)
@_implementationOnly import CSystem
import Glibc
#elseif os(Windows)
import CSystem
@@ -60,7 +60,10 @@ internal func system_strerror(_ __errnum: Int32) -> UnsafeMutablePointer<Int8>!
strerror(__errnum)
}
internal func system_strlen(_ s: UnsafePointer<Int8>) -> Int {
internal func system_strlen(_ s: UnsafePointer<CChar>) -> Int {
strlen(s)
}
internal func system_strlen(_ s: UnsafeMutablePointer<CChar>) -> Int {
strlen(s)
}
@@ -78,6 +81,16 @@ internal func system_platform_strlen(_ s: UnsafePointer<CInterop.PlatformChar>)
#endif
}
// memset for raw buffers
// FIXME: Do we really not have something like this in the stdlib already?
internal func system_memset(
_ buffer: UnsafeMutableRawBufferPointer,
to byte: UInt8
) {
guard buffer.count > 0 else { return }
memset(buffer.baseAddress!, CInt(byte), buffer.count)
}
// Interop between String and platfrom string
extension String {
internal func _withPlatformString<Result>(
+8 -7
View File
@@ -19,9 +19,10 @@
#if ENABLE_MOCKING
internal struct Trace {
internal struct Entry: Hashable {
private var name: String
private var arguments: [AnyHashable]
internal struct Entry {
internal var name: String
internal var arguments: [AnyHashable]
internal init(name: String, _ arguments: [AnyHashable]) {
self.name = name
@@ -146,7 +147,7 @@ private func originalSyscallName(_ function: String) -> String {
private func mockImpl(
name: String,
path: UnsafePointer<CChar>?,
path: UnsafePointer<CInterop.PlatformChar>?,
_ args: [AnyHashable]
) -> CInt {
precondition(mockingEnabled)
@@ -177,18 +178,18 @@ private func mockImpl(
}
internal func _mock(
name: String = #function, path: UnsafePointer<CChar>? = nil, _ args: AnyHashable...
name: String = #function, path: UnsafePointer<CInterop.PlatformChar>? = nil, _ args: AnyHashable...
) -> CInt {
return mockImpl(name: name, path: path, args)
}
internal func _mockInt(
name: String = #function, path: UnsafePointer<CChar>? = nil, _ args: AnyHashable...
name: String = #function, path: UnsafePointer<CInterop.PlatformChar>? = nil, _ args: AnyHashable...
) -> Int {
Int(mockImpl(name: name, path: path, args))
}
internal func _mockOffT(
name: String = #function, path: UnsafePointer<CChar>? = nil, _ args: AnyHashable...
name: String = #function, path: UnsafePointer<CInterop.PlatformChar>? = nil, _ args: AnyHashable...
) -> _COffT {
_COffT(mockImpl(name: name, path: path, args))
}
+102
View File
@@ -0,0 +1,102 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
// A copy-on-write fixed-size buffer of raw memory.
internal struct _RawBuffer {
internal var _storage: Storage?
internal init() {
self._storage = nil
}
internal init(minimumCapacity: Int) {
if minimumCapacity > 0 {
self._storage = Storage.create(minimumCapacity: minimumCapacity)
} else {
self._storage = nil
}
}
}
extension _RawBuffer {
internal var capacity: Int {
_storage?.header ?? 0 // Note: not capacity!
}
internal mutating func ensureUnique() {
guard _storage != nil else { return }
let unique = isKnownUniquelyReferenced(&_storage)
if !unique {
_storage = _copy(capacity: capacity)
}
}
internal func _grow(desired: Int) -> Int {
let next = Int(1.75 * Double(self.capacity))
return Swift.max(next, desired)
}
internal mutating func ensureUnique(capacity: Int) {
let unique = isKnownUniquelyReferenced(&_storage)
if !unique || self.capacity < capacity {
_storage = _copy(capacity: _grow(desired: capacity))
}
}
internal func withUnsafeBytes<R>(
_ body: (UnsafeRawBufferPointer) throws -> R
) rethrows -> R {
guard let storage = _storage else {
return try body(UnsafeRawBufferPointer(start: nil, count: 0))
}
return try storage.withUnsafeMutablePointers { count, bytes in
let buffer = UnsafeRawBufferPointer(start: bytes, count: count.pointee)
return try body(buffer)
}
}
internal mutating func withUnsafeMutableBytes<R>(
_ body: (UnsafeMutableRawBufferPointer) throws -> R
) rethrows -> R {
guard _storage != nil else {
return try body(UnsafeMutableRawBufferPointer(start: nil, count: 0))
}
ensureUnique()
return try _storage!.withUnsafeMutablePointers { count, bytes in
let buffer = UnsafeMutableRawBufferPointer(start: bytes, count: count.pointee)
return try body(buffer)
}
}
}
extension _RawBuffer {
internal class Storage: ManagedBuffer<Int, UInt8> {
internal static func create(minimumCapacity: Int) -> Storage {
Storage.create(
minimumCapacity: minimumCapacity,
makingHeaderWith: { $0.capacity }
) as! Storage
}
}
internal func _copy(capacity: Int) -> Storage {
let copy = Storage.create(minimumCapacity: capacity)
copy.withUnsafeMutablePointers { dstlen, dst in
self.withUnsafeBytes { src in
guard src.count > 0 else { return }
assert(src.count <= dstlen.pointee)
UnsafeMutableRawPointer(dst)
.copyMemory(
from: src.baseAddress!,
byteCount: Swift.min(src.count, dstlen.pointee))
}
}
return copy
}
}
+24 -6
View File
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
@@ -9,7 +9,7 @@
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
import Darwin
#elseif os(Linux) || os(FreeBSD) || os(Android)
#elseif os(Linux) || os(FreeBSD) || os(OpenBSD) || os(Android)
import Glibc
#elseif os(Windows)
import ucrt
@@ -54,7 +54,7 @@ internal func system_close(_ fd: Int32) -> Int32 {
// read
internal func system_read(
_ fd: Int32, _ buf: UnsafeMutableRawPointer!, _ nbyte: Int
_ fd: Int32, _ buf: UnsafeMutableRawPointer?, _ nbyte: Int
) -> Int {
#if ENABLE_MOCKING
if mockingEnabled { return _mockInt(fd, buf, nbyte) }
@@ -64,7 +64,7 @@ internal func system_read(
// pread
internal func system_pread(
_ fd: Int32, _ buf: UnsafeMutableRawPointer!, _ nbyte: Int, _ offset: off_t
_ fd: Int32, _ buf: UnsafeMutableRawPointer?, _ nbyte: Int, _ offset: off_t
) -> Int {
#if ENABLE_MOCKING
if mockingEnabled { return _mockInt(fd, buf, nbyte, offset) }
@@ -84,7 +84,7 @@ internal func system_lseek(
// write
internal func system_write(
_ fd: Int32, _ buf: UnsafeRawPointer!, _ nbyte: Int
_ fd: Int32, _ buf: UnsafeRawPointer?, _ nbyte: Int
) -> Int {
#if ENABLE_MOCKING
if mockingEnabled { return _mockInt(fd, buf, nbyte) }
@@ -94,7 +94,7 @@ internal func system_write(
// pwrite
internal func system_pwrite(
_ fd: Int32, _ buf: UnsafeRawPointer!, _ nbyte: Int, _ offset: off_t
_ fd: Int32, _ buf: UnsafeRawPointer?, _ nbyte: Int, _ offset: off_t
) -> Int {
#if ENABLE_MOCKING
if mockingEnabled { return _mockInt(fd, buf, nbyte, offset) }
@@ -115,3 +115,21 @@ internal func system_dup2(_ fd: Int32, _ fd2: Int32) -> Int32 {
#endif
return dup2(fd, fd2)
}
#if !os(Windows)
internal func system_pipe(_ fds: UnsafeMutablePointer<Int32>) -> CInt {
#if ENABLE_MOCKING
if mockingEnabled { return _mock(fds) }
#endif
return pipe(fds)
}
#endif
#if !os(Windows)
internal func system_ftruncate(_ fd: Int32, _ length: off_t) -> Int32 {
#if ENABLE_MOCKING
if mockingEnabled { return _mock(fd, length) }
#endif
return ftruncate(fd, length)
}
#endif
@@ -58,6 +58,23 @@ internal func write(
Int(_write(fd, buf, numericCast(nbyte)))
}
@inline(__always)
internal func lseek(
_ fd: Int32, _ off: off_t, _ whence: Int32
) -> off_t {
_lseek(fd, off, whence)
}
@inline(__always)
internal func dup(_ fd: Int32) -> Int32 {
_dup(fd)
}
@inline(__always)
internal func dup2(_ fd: Int32, _ fd2: Int32) -> Int32 {
_dup2(fd, fd2)
}
@inline(__always)
internal func pread(
_ fd: Int32, _ buf: UnsafeMutableRawPointer!, _ nbyte: Int, _ offset: off_t
+353
View File
@@ -0,0 +1,353 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2022 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
#if swift(>=5.8) && $MoveOnly && (os(macOS) || os(iOS) || os(watchOS) || os(tvOS))
import Darwin.Mach
public protocol MachPortRight {}
@inlinable
internal func _machPrecondition(
file: StaticString = #file,
line: UInt = #line,
_ body: @autoclosure () -> kern_return_t
) {
let kr = body()
let expected = KERN_SUCCESS
precondition(kr == expected, file: file, line: line)
}
@available(/*System 1.3.0: macOS 9999, iOS 9999, watchOS 9999, tvOS 9999*/iOS 8, *)
@frozen
public enum Mach {
@_moveOnly
public struct Port<RightType: MachPortRight> {
@usableFromInline
internal var _name: mach_port_name_t
@usableFromInline
internal var _context: mach_port_context_t
/// Transfer ownership of an existing unmanaged Mach port right into a
/// `Mach.Port` by name.
///
/// This initializer traps if `name` is `MACH_PORT_NULL`, or if `name` is
/// `MACH_PORT_DEAD` and the `RightType` is `Mach.ReceiveRight`.
///
/// If the type of the right does not match the `RightType` of the
/// `Mach.Port` being constructed, behavior is undefined.
///
/// The underlying port right will be automatically deallocated at the
/// end of the `Mach.Port` instance's lifetime.
///
/// This initializer makes a syscall to guard the right.
public init(name: mach_port_name_t) {
precondition(name != mach_port_name_t(MACH_PORT_NULL), "Mach.Port cannot be initialized with MACH_PORT_NULL")
self._name = name
if RightType.self == ReceiveRight.self {
precondition(name != 0xFFFFFFFF /* MACH_PORT_DEAD */, "Receive rights cannot be dead names")
let secret = mach_port_context_t(arc4random())
_machPrecondition(mach_port_guard(mach_task_self_, name, secret, 0))
self._context = secret
}
else {
self._context = 0
}
}
/// Borrow access to the port name in a block that can perform
/// non-consuming operations.
///
/// Take care when using this function; many operations consume rights,
/// and send-once rights are easily consumed.
///
/// If the right is consumed, behavior is undefined.
///
/// The body block may optionally return something, which will then be
/// returned to the caller of withBorrowedName.
@inlinable
public func withBorrowedName<ReturnType>(
body: (mach_port_name_t) -> ReturnType
) -> ReturnType {
return body(_name)
}
deinit {
if _name == 0xFFFFFFFF /* MACH_PORT_DEAD */ {
precondition(RightType.self != ReceiveRight.self, "Receive rights cannot be dead names")
_machPrecondition(mach_port_mod_refs(mach_task_self_, _name, MACH_PORT_RIGHT_DEAD_NAME, -1))
} else {
if RightType.self == ReceiveRight.self {
_machPrecondition(mach_port_destruct(mach_task_self_, _name, -1, _context))
} else if RightType.self == SendRight.self {
_machPrecondition(mach_port_mod_refs(mach_task_self_, _name, MACH_PORT_RIGHT_SEND, -1))
} else if RightType.self == SendOnceRight.self {
_machPrecondition(mach_port_mod_refs(mach_task_self_, _name, MACH_PORT_RIGHT_SEND_ONCE, -1))
}
}
}
}
/// Possible errors that can be thrown by Mach.Port operations.
public enum PortRightError : Error {
/// Returned when an operation cannot be completed, because the Mach
/// port right has become a dead name. This is caused by deallocation of the
/// receive right on the other end.
case deadName
}
/// The MachPortRight type used to manage a receive right.
@frozen
public struct ReceiveRight: MachPortRight {}
/// The MachPortRight type used to manage a send right.
@frozen
public struct SendRight: MachPortRight {}
/// The MachPortRight type used to manage a send-once right.
///
/// Send-once rights are the most restrictive type of Mach port rights.
/// They cannot create other rights, and are consumed upon use.
///
/// Upon destruction a send-once notification will be sent to the
/// receiving end.
@frozen
public struct SendOnceRight: MachPortRight {}
/// Create a connected pair of rights, one receive, and one send.
///
/// This function will abort if the rights could not be created.
/// Callers may assert that valid rights are always returned.
public static func allocatePortRightPair() ->
(receive: Mach.Port<Mach.ReceiveRight>, send: Mach.Port<Mach.SendRight>) {
var name = mach_port_name_t(MACH_PORT_NULL)
let secret = mach_port_context_t(arc4random())
withUnsafeMutablePointer(to: &name) { name in
var options = mach_port_options_t()
options.flags = UInt32(MPO_INSERT_SEND_RIGHT);
withUnsafeMutablePointer(to: &options) { options in
_machPrecondition(mach_port_construct(mach_task_self_, options, secret, name))
}
}
return (Mach.Port(name: name, context: secret), Mach.Port(name: name))
}
}
extension Mach.Port where RightType == Mach.ReceiveRight {
/// Transfer ownership of an existing, unmanaged, but already guarded,
/// Mach port right into a Mach.Port by name.
///
/// This initializer aborts if name is MACH_PORT_NULL.
///
/// If the type of the right does not match the type T of Mach.Port<T>
/// being constructed, the behavior is undefined.
///
/// The underlying port right will be automatically deallocated when
/// the Mach.Port object is destroyed.
public init(name: mach_port_name_t, context: mach_port_context_t) {
self._name = name
self._context = context
}
/// Allocate a new Mach port with a receive right, creating a
/// Mach.Port<Mach.ReceiveRight> to manage it.
///
/// This initializer will abort if the right could not be created.
/// Callers may assert that a valid right is always returned.
@inlinable
public init() {
var storage: mach_port_name_t = mach_port_name_t(MACH_PORT_NULL)
withUnsafeMutablePointer(to: &storage) { storage in
_machPrecondition(mach_port_allocate(mach_task_self_, MACH_PORT_RIGHT_RECEIVE, storage))
}
// name-only init will guard ReceiveRights
self.init(name: storage)
}
/// Transfer ownership of the underlying port right to the caller.
///
/// Returns a tuple containing the Mach port name representing the right,
/// and the context value used to guard the right.
///
/// This operation liberates the right from management by the Mach.Port,
/// and the underlying right will no longer be automatically deallocated.
///
/// After this function completes, the Mach.Port is destroyed and no longer
/// usable.
@inlinable
public __consuming func relinquish(
) -> (name: mach_port_name_t, context: mach_port_context_t) {
return (name: _name, context: _context)
}
/// Remove guard and transfer ownership of the underlying port right to
/// the caller.
///
/// Returns the Mach port name representing the right.
///
/// This operation liberates the right from management by the Mach.Port,
/// and the underlying right will no longer be automatically deallocated.
///
/// After this function completes, the Mach.Port is destroyed and no longer
/// usable.
///
/// This function makes a syscall to remove the guard from
/// Mach.ReceiveRights. Use relinquish() to avoid the syscall and extract
/// the context value along with the port name.
@inlinable
public __consuming func unguardAndRelinquish() -> mach_port_name_t {
_machPrecondition(mach_port_unguard(mach_task_self_, _name, _context))
return _name
}
/// Borrow access to the port name in a block that can perform
/// non-consuming operations.
///
/// Take care when using this function; many operations consume rights.
///
/// If the right is consumed, behavior is undefined.
///
/// The body block may optionally return something, which will then be
/// returned to the caller of withBorrowedName.
@inlinable
public func withBorrowedName<ReturnType>(
body: (mach_port_name_t, mach_port_context_t) -> ReturnType
) -> ReturnType {
return body(_name, _context)
}
/// Create a send-once right for a given receive right.
///
/// This does not affect the makeSendCount of the receive right.
///
/// This function will abort if the right could not be created.
/// Callers may assert that a valid right is always returned.
@inlinable
public func makeSendOnceRight() -> Mach.Port<Mach.SendOnceRight> {
// send once rights do not coalesce
var newRight: mach_port_name_t = mach_port_name_t(MACH_PORT_NULL)
var newRightType: mach_port_type_t = MACH_PORT_TYPE_NONE
withUnsafeMutablePointer(to: &newRight) { newRight in
withUnsafeMutablePointer(to: &newRightType) { newRightType in
_machPrecondition(
mach_port_extract_right(mach_task_self_,
_name,
mach_msg_type_name_t(MACH_MSG_TYPE_MAKE_SEND_ONCE),
newRight,
newRightType)
)
}
}
// The value of newRight is validated by the Mach.Port initializer
precondition(newRightType == MACH_MSG_TYPE_MOVE_SEND_ONCE)
return Mach.Port(name: newRight)
}
/// Create a send right for a given receive right.
///
/// This increments the makeSendCount of the receive right.
///
/// This function will abort if the right could not be created.
/// Callers may assert that a valid right is always returned.
@inlinable
public func makeSendRight() -> Mach.Port<Mach.SendRight> {
let how = MACH_MSG_TYPE_MAKE_SEND
// name is the same because send and recv rights are coalesced
_machPrecondition(mach_port_insert_right(mach_task_self_, _name, _name, mach_msg_type_name_t(how)))
return Mach.Port(name: _name)
}
/// Access the make-send count.
///
/// Each get/set of this property makes a syscall.
@inlinable
public var makeSendCount: mach_port_mscount_t {
get {
var status: mach_port_status = mach_port_status()
var size: mach_msg_type_number_t = mach_msg_type_number_t(MemoryLayout<mach_port_status>.size / MemoryLayout<natural_t>.size)
withUnsafeMutablePointer(to: &size) { size in
withUnsafeMutablePointer(to: &status) { status in
let info = UnsafeMutableRawPointer(status).bindMemory(to: integer_t.self, capacity: 1)
_machPrecondition(mach_port_get_attributes(mach_task_self_, _name, MACH_PORT_RECEIVE_STATUS, info, size))
}
}
return status.mps_mscount
}
set {
_machPrecondition(mach_port_set_mscount(mach_task_self_, _name, newValue))
}
}
}
extension Mach.Port where RightType == Mach.SendRight {
/// Transfer ownership of the underlying port right to the caller.
///
/// Returns the Mach port name representing the right.
///
/// This operation liberates the right from management by the Mach.Port,
/// and the underlying right will no longer be automatically deallocated.
///
/// After this function completes, the Mach.Port is destroyed and no longer
/// usable.
@inlinable
public __consuming func relinquish() -> mach_port_name_t {
return _name
}
/// Create another send right from a given send right.
///
/// This does not affect the makeSendCount of the receive right.
///
/// If the send right being copied has become a dead name, meaning the
/// receiving side has been deallocated, then copySendRight() will throw
/// a Mach.PortRightError.deadName error.
@inlinable
public func copySendRight() throws -> Mach.Port<Mach.SendRight> {
let how = MACH_MSG_TYPE_COPY_SEND
// name is the same because send rights are coalesced
let kr = mach_port_insert_right(mach_task_self_, _name, _name, mach_msg_type_name_t(how))
if kr == KERN_INVALID_CAPABILITY {
throw Mach.PortRightError.deadName
}
_machPrecondition(kr)
return Mach.Port(name: _name)
}
}
extension Mach.Port where RightType == Mach.SendOnceRight {
/// Transfer ownership of the underlying port right to the caller.
///
/// Returns the Mach port name representing the right.
///
/// This operation liberates the right from management by the Mach.Port,
/// and the underlying right will no longer be automatically deallocated.
///
/// After this function completes, the Mach.Port is destroyed and no longer
/// usable.
@inlinable
public __consuming func relinquish() -> mach_port_name_t {
return _name
}
}
#endif
+110 -1
View File
@@ -7,7 +7,7 @@
See https://swift.org/LICENSE.txt for license information
*/
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension String {
/// Creates a string by interpreting the null-terminated platform string as
/// UTF-8 on Unix and UTF-16 on Windows.
@@ -24,6 +24,56 @@ extension String {
self.init(_errorCorrectingPlatformString: platformString)
}
/// Creates a string by interpreting the null-terminated platform string as
/// UTF-8 on Unix and UTF-16 on Windows.
///
/// - Parameter platformString: The null-terminated platform string to be
/// interpreted as `CInterop.PlatformUnicodeEncoding`.
///
/// - Note It is a precondition that `platformString` must be null-terminated.
/// The absence of a null byte will trigger a runtime error.
///
/// If the content of the platform string isn't well-formed Unicode,
/// this initializer replaces invalid bytes with U+FFFD.
/// This means that, depending on the semantics of the specific platform,
/// conversion to a string and back might result in a value that's different
/// from the original platform string.
@inlinable
@_alwaysEmitIntoClient
public init(platformString: [CInterop.PlatformChar]) {
guard let _ = platformString.firstIndex(of: 0) else {
fatalError(
"input of String.init(platformString:) must be null-terminated"
)
}
self = platformString.withUnsafeBufferPointer {
String(platformString: $0.baseAddress!)
}
}
@inlinable
@_alwaysEmitIntoClient
@available(*, deprecated, message: "Use String.init(_ scalar: Unicode.Scalar)")
public init(platformString: inout CInterop.PlatformChar) {
guard platformString == 0 else {
fatalError(
"input of String.init(platformString:) must be null-terminated"
)
}
self = ""
}
@inlinable
@_alwaysEmitIntoClient
@available(*, deprecated, message: "Use a copy of the String argument")
public init(platformString: String) {
if let nullLoc = platformString.firstIndex(of: "\0") {
self = String(platformString[..<nullLoc])
} else {
self = platformString
}
}
/// Creates a string by interpreting the null-terminated platform string as
/// UTF-8 on Unix and UTF-16 on Windows.
///
@@ -38,6 +88,62 @@ extension String {
self.init(_platformString: platformString)
}
/// Creates a string by interpreting the null-terminated platform string as
/// UTF-8 on Unix and UTF-16 on Windows.
///
/// - Parameter platformString: The null-terminated platform string to be
/// interpreted as `CInterop.PlatformUnicodeEncoding`.
///
/// - Note It is a precondition that `platformString` must be null-terminated.
/// The absence of a null byte will trigger a runtime error.
///
/// If the contents of the platform string isn't well-formed Unicode,
/// this initializer returns `nil`.
@inlinable
@_alwaysEmitIntoClient
public init?(
validatingPlatformString platformString: [CInterop.PlatformChar]
) {
guard let _ = platformString.firstIndex(of: 0) else {
fatalError(
"input of String.init(validatingPlatformString:) must be null-terminated"
)
}
guard let string = platformString.withUnsafeBufferPointer({
String(validatingPlatformString: $0.baseAddress!)
}) else {
return nil
}
self = string
}
@inlinable
@_alwaysEmitIntoClient
@available(*, deprecated, message: "Use String(_ scalar: Unicode.Scalar)")
public init?(
validatingPlatformString platformString: inout CInterop.PlatformChar
) {
guard platformString == 0 else {
fatalError(
"input of String.init(validatingPlatformString:) must be null-terminated"
)
}
self = ""
}
@inlinable
@_alwaysEmitIntoClient
@available(*, deprecated, message: "Use a copy of the String argument")
public init?(
validatingPlatformString platformString: String
) {
if let nullLoc = platformString.firstIndex(of: "\0") {
self = String(platformString[..<nullLoc])
} else {
self = platformString
}
}
/// Calls the given closure with a pointer to the contents of the string,
/// represented as a null-terminated platform string.
///
@@ -58,6 +164,7 @@ extension String {
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension CInterop.PlatformChar {
internal var _platformCodeUnit: CInterop.PlatformUnicodeEncoding.CodeUnit {
#if os(Windows)
@@ -67,6 +174,8 @@ extension CInterop.PlatformChar {
#endif
}
}
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension CInterop.PlatformUnicodeEncoding.CodeUnit {
internal var _platformChar: CInterop.PlatformChar {
#if os(Windows)
+25 -15
View File
@@ -53,8 +53,8 @@ extension SystemChar {
internal var isLetter: Bool {
guard isASCII else { return false }
let asciiRaw: UInt8 = numericCast(rawValue)
return (UInt8(ascii: "a") ..< UInt8(ascii: "z")).contains(asciiRaw) ||
(UInt8(ascii: "A") ..< UInt8(ascii: "Z")).contains(asciiRaw)
return (UInt8(ascii: "a") ... UInt8(ascii: "z")).contains(asciiRaw) ||
(UInt8(ascii: "A") ... UInt8(ascii: "Z")).contains(asciiRaw)
}
}
@@ -171,12 +171,15 @@ extension SystemString {
internal func withCodeUnits<T>(
_ f: (UnsafeBufferPointer<CInterop.PlatformUnicodeEncoding.CodeUnit>) throws -> T
) rethrows -> T {
try withSystemChars {
// TODO: Is this the right way?
let base = UnsafeRawPointer(
$0.baseAddress
)!.assumingMemoryBound(to: CInterop.PlatformUnicodeEncoding.CodeUnit.self)
return try f(UnsafeBufferPointer(start: base, count: $0.count))
try withSystemChars { chars in
let length = chars.count * MemoryLayout<SystemChar>.stride
let count = length / MemoryLayout<CInterop.PlatformUnicodeEncoding.CodeUnit>.stride
return try chars.baseAddress!.withMemoryRebound(
to: CInterop.PlatformUnicodeEncoding.CodeUnit.self,
capacity: count
) { pointer in
try f(UnsafeBufferPointer(start: pointer, count: count))
}
}
}
}
@@ -272,17 +275,24 @@ extension SystemString {
internal func withPlatformString<T>(
_ f: (UnsafePointer<CInterop.PlatformChar>) throws -> T
) rethrows -> T {
try withSystemChars {
// TODO: Is this the right way?
let base = UnsafeRawPointer(
$0.baseAddress
)!.assumingMemoryBound(to: CInterop.PlatformChar.self)
assert(base[self.count] == 0)
return try f(base)
try withSystemChars { chars in
let length = chars.count * MemoryLayout<SystemChar>.stride
return try chars.baseAddress!.withMemoryRebound(
to: CInterop.PlatformChar.self,
capacity: length / MemoryLayout<CInterop.PlatformChar>.stride
) { pointer in
assert(pointer[self.count] == 0)
return try f(pointer)
}
}
}
}
#if compiler(>=5.5) && canImport(_Concurrency)
extension SystemChar: Sendable {}
extension SystemString: Sendable {}
#endif
// TODO: SystemString should use a COW-interchangable storage form rather
// than array, so you could "borrow" the storage from a non-bridged String
// or Data or whatever
+117
View File
@@ -0,0 +1,117 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
extension Array where Element == String {
internal typealias CStr = UnsafePointer<CChar>?
/// Call `body` with a buffer of `UnsafePointer<CChar>?` values,
/// suitable for passing to a C function that expects a C string array.
/// The buffer is guaranteed to be followed by an extra storage slot
/// containing a null pointer. (For C functions that expect an array
/// terminated with a null pointer.)
///
/// This function is careful not to heap allocate memory unless there are
/// too many strings, or if it needs to copy too much character data.
internal func _withCStringArray<R>(
_ body: (UnsafeBufferPointer<UnsafePointer<CChar>?>) throws -> R
) rethrows -> R {
if self.count == 0 {
// Fast path: empty array.
let p: CStr = nil
return try Swift.withUnsafePointer(to: p) { array in
try body(UnsafeBufferPointer(start: array, count: 0))
}
}
#if SYSTEM_OS_BUILD // String._guts isn't accessible from SwiftPM or CMake
if self.count == 1, self[0]._guts._isLargeZeroTerminatedContiguousUTF8 {
// Fast path: Single fast string.
let start = self[0]._guts._largeContiguousUTF8CodeUnits.baseAddress!
var p: (CStr, CStr) = (
UnsafeRawPointer(start).assumingMemoryBound(to: CChar.self),
nil
)
return try Swift.withUnsafeBytes(of: &p) { buffer in
let start = buffer.baseAddress!.assumingMemoryBound(to: CStr.self)
return try body(UnsafeBufferPointer(start: start, count: 1))
}
}
#endif
// We need to create a buffer for the C array.
return try _withStackBuffer(
capacity: (self.count + 1) * MemoryLayout<CStr>.stride
) { array in
let array = array.bindMemory(to: CStr.self)
// Calculate number of bytes we need for character storage
let bytes = self.reduce(into: 0) { count, string in
#if SYSTEM_OS_BUILD
if string._guts._isLargeZeroTerminatedContiguousUTF8 { return }
#endif
count += string.utf8.count + 1 // Plus one for terminating NUL
}
#if SYSTEM_OS_BUILD
if bytes == 0 {
// Fast path: we only contain strings with stable null-terminated storage
for i in self.indices {
let string = self[i]
precondition(string._guts._isLargeZeroTerminatedContiguousUTF8)
let address = string._guts._largeContiguousUTF8CodeUnits.baseAddress!
array[i] = UnsafeRawPointer(address).assumingMemoryBound(to: CChar.self)
}
array[self.count] = nil
return try body(UnsafeBufferPointer(rebasing: array.dropLast()))
}
#endif
return try _withStackBuffer(capacity: bytes) { chars in
var chars = chars
for i in self.indices {
let (cstr, scratchUsed) = self[i]._getCStr(with: chars)
array[i] = cstr.assumingMemoryBound(to: CChar.self)
chars = .init(rebasing: chars[scratchUsed...])
}
array[self.count] = nil
return try body(UnsafeBufferPointer(rebasing: array.dropLast()))
}
}
}
}
extension String {
fileprivate func _getCStr(
with scratch: UnsafeMutableRawBufferPointer
) -> (cstr: UnsafeRawPointer, scratchUsed: Int) {
#if SYSTEM_OS_BUILD
if _guts._isLargeZeroTerminatedContiguousUTF8 {
// This is a wonderful string, we can just use its storage address.
let address = _guts._largeContiguousUTF8CodeUnits.baseAddress!
return (UnsafeRawPointer(address), 0)
}
#endif
let r: (UnsafeRawPointer, Int)? = self.utf8.withContiguousStorageIfAvailable { source in
// This is a somewhat okay string -- we need to use memcpy.
precondition(source.count <= scratch.count)
let start = scratch.baseAddress!
start.copyMemory(from: source.baseAddress!, byteCount: source.count)
start.storeBytes(of: 0, toByteOffset: source.count, as: UInt8.self)
return (UnsafeRawPointer(start), source.count + 1)
}
if let r = r { return r }
// What a horrible string; we need to copy individual bytes.
precondition(self.utf8.count <= scratch.count)
var c = 0
for byte in self.utf8 {
scratch[c] = byte
c += 1
}
scratch[c] = 0
c += 1
return (UnsafeRawPointer(scratch.baseAddress!), c)
}
}
+40 -5
View File
@@ -1,28 +1,28 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 Apple Inc. and the Swift System project authors
Copyright (c) 2020 - 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
// Results in errno if i == -1
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
private func valueOrErrno<I: FixedWidthInteger>(
_ i: I
) -> Result<I, Errno> {
i == -1 ? .failure(Errno.current) : .success(i)
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
private func nothingOrErrno<I: FixedWidthInteger>(
_ i: I
) -> Result<(), Errno> {
valueOrErrno(i).map { _ in () }
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
internal func valueOrErrno<I: FixedWidthInteger>(
retryOnInterrupt: Bool, _ f: () -> I
) -> Result<I, Errno> {
@@ -36,7 +36,7 @@ internal func valueOrErrno<I: FixedWidthInteger>(
} while true
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
internal func nothingOrErrno<I: FixedWidthInteger>(
retryOnInterrupt: Bool, _ f: () -> I
) -> Result<(), Errno> {
@@ -127,3 +127,38 @@ extension MutableCollection where Element: Equatable {
}
}
}
internal func _withOptionalUnsafePointerOrNull<T, R>(
to value: T?,
_ body: (UnsafePointer<T>?) throws -> R
) rethrows -> R {
guard let value = value else {
return try body(nil)
}
return try withUnsafePointer(to: value, body)
}
/// Calls `body` with a temporary buffer of the indicated size,
/// possibly stack-allocated.
internal func _withStackBuffer<R>(
capacity: Int,
_ body: (UnsafeMutableRawBufferPointer) throws -> R
) rethrows -> R {
typealias StackStorage = (
UInt64, UInt64, UInt64, UInt64,
UInt64, UInt64, UInt64, UInt64,
UInt64, UInt64, UInt64, UInt64,
UInt64, UInt64, UInt64, UInt64
)
if capacity > MemoryLayout<StackStorage>.size {
var buffer = _RawBuffer(minimumCapacity: capacity)
return try buffer.withUnsafeMutableBytes { buffer in
try body(.init(rebasing: buffer[..<capacity]))
}
} else {
var storage: StackStorage = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
return try withUnsafeMutableBytes(of: &storage) { buffer in
try body(.init(rebasing: buffer[..<capacity]))
}
}
}
+42 -1
View File
@@ -15,7 +15,11 @@ import SystemPackage
import System
#endif
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
#if os(Windows)
import WinSDK
#endif
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
final class ErrnoTest: XCTestCase {
func testConstants() {
XCTAssert(EPERM == Errno.notPermitted.rawValue)
@@ -32,7 +36,9 @@ final class ErrnoTest: XCTestCase {
XCTAssert(ENOMEM == Errno.noMemory.rawValue)
XCTAssert(EACCES == Errno.permissionDenied.rawValue)
XCTAssert(EFAULT == Errno.badAddress.rawValue)
#if !os(Windows)
XCTAssert(ENOTBLK == Errno.notBlockDevice.rawValue)
#endif
XCTAssert(EBUSY == Errno.resourceBusy.rawValue)
XCTAssert(EEXIST == Errno.fileExists.rawValue)
XCTAssert(EXDEV == Errno.improperLink.rawValue)
@@ -42,8 +48,10 @@ final class ErrnoTest: XCTestCase {
XCTAssert(EINVAL == Errno.invalidArgument.rawValue)
XCTAssert(ENFILE == Errno.tooManyOpenFilesInSystem.rawValue)
XCTAssert(EMFILE == Errno.tooManyOpenFiles.rawValue)
#if !os(Windows)
XCTAssert(ENOTTY == Errno.inappropriateIOCTLForDevice.rawValue)
XCTAssert(ETXTBSY == Errno.textFileBusy.rawValue)
#endif
XCTAssert(EFBIG == Errno.fileTooLarge.rawValue)
XCTAssert(ENOSPC == Errno.noSpace.rawValue)
XCTAssert(ESPIPE == Errno.illegalSeek.rawValue)
@@ -61,9 +69,15 @@ final class ErrnoTest: XCTestCase {
XCTAssert(EPROTOTYPE == Errno.protocolWrongTypeForSocket.rawValue)
XCTAssert(ENOPROTOOPT == Errno.protocolNotAvailable.rawValue)
XCTAssert(EPROTONOSUPPORT == Errno.protocolNotSupported.rawValue)
#if os(Windows)
XCTAssert(WSAESOCKTNOSUPPORT == Errno.socketTypeNotSupported.rawValue)
XCTAssert(WSAEOPNOTSUPP == Errno.notSupported.rawValue)
XCTAssert(WSAEPFNOSUPPORT == Errno.protocolFamilyNotSupported.rawValue)
#else
XCTAssert(ESOCKTNOSUPPORT == Errno.socketTypeNotSupported.rawValue)
XCTAssert(ENOTSUP == Errno.notSupported.rawValue)
XCTAssert(EPFNOSUPPORT == Errno.protocolFamilyNotSupported.rawValue)
#endif
XCTAssert(EAFNOSUPPORT == Errno.addressFamilyNotSupported.rawValue)
XCTAssert(EADDRINUSE == Errno.addressInUse.rawValue)
XCTAssert(EADDRNOTAVAIL == Errno.addressNotAvailable.rawValue)
@@ -75,12 +89,20 @@ final class ErrnoTest: XCTestCase {
XCTAssert(ENOBUFS == Errno.noBufferSpace.rawValue)
XCTAssert(EISCONN == Errno.socketIsConnected.rawValue)
XCTAssert(ENOTCONN == Errno.socketNotConnected.rawValue)
#if os(Windows)
XCTAssert(WSAESHUTDOWN == Errno.socketShutdown.rawValue)
#else
XCTAssert(ESHUTDOWN == Errno.socketShutdown.rawValue)
#endif
XCTAssert(ETIMEDOUT == Errno.timedOut.rawValue)
XCTAssert(ECONNREFUSED == Errno.connectionRefused.rawValue)
XCTAssert(ELOOP == Errno.tooManySymbolicLinkLevels.rawValue)
XCTAssert(ENAMETOOLONG == Errno.fileNameTooLong.rawValue)
#if os(Windows)
XCTAssert(WSAEHOSTDOWN == Errno.hostIsDown.rawValue)
#else
XCTAssert(EHOSTDOWN == Errno.hostIsDown.rawValue)
#endif
XCTAssert(EHOSTUNREACH == Errno.noRouteToHost.rawValue)
XCTAssert(ENOTEMPTY == Errno.directoryNotEmpty.rawValue)
@@ -88,9 +110,15 @@ final class ErrnoTest: XCTestCase {
XCTAssert(EPROCLIM == Errno.tooManyProcesses.rawValue)
#endif
#if os(Windows)
XCTAssert(WSAEUSERS == Errno.tooManyUsers.rawValue)
XCTAssert(WSAEDQUOT == Errno.diskQuotaExceeded.rawValue)
XCTAssert(WSAESTALE == Errno.staleNFSFileHandle.rawValue)
#else
XCTAssert(EUSERS == Errno.tooManyUsers.rawValue)
XCTAssert(EDQUOT == Errno.diskQuotaExceeded.rawValue)
XCTAssert(ESTALE == Errno.staleNFSFileHandle.rawValue)
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
XCTAssert(EBADRPC == Errno.rpcUnsuccessful.rawValue)
@@ -111,7 +139,9 @@ final class ErrnoTest: XCTestCase {
XCTAssert(EDEVERR == Errno.deviceError.rawValue)
#endif
#if !os(Windows)
XCTAssert(EOVERFLOW == Errno.overflow.rawValue)
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
XCTAssert(EBADEXEC == Errno.badExecutable.rawValue)
@@ -121,14 +151,17 @@ final class ErrnoTest: XCTestCase {
#endif
XCTAssert(ECANCELED == Errno.canceled.rawValue)
#if !os(Windows)
XCTAssert(EIDRM == Errno.identifierRemoved.rawValue)
XCTAssert(ENOMSG == Errno.noMessage.rawValue)
#endif
XCTAssert(EILSEQ == Errno.illegalByteSequence.rawValue)
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
XCTAssert(ENOATTR == Errno.attributeNotFound.rawValue)
#endif
#if !os(Windows)
XCTAssert(EBADMSG == Errno.badMessage.rawValue)
XCTAssert(EMULTIHOP == Errno.multiHop.rawValue)
XCTAssert(ENODATA == Errno.noData.rawValue)
@@ -137,19 +170,27 @@ final class ErrnoTest: XCTestCase {
XCTAssert(ENOSTR == Errno.notStream.rawValue)
XCTAssert(EPROTO == Errno.protocolError.rawValue)
XCTAssert(ETIME == Errno.timeout.rawValue)
#endif
XCTAssert(EOPNOTSUPP == Errno.notSupportedOnSocket.rawValue)
// From headers but not man page
XCTAssert(EWOULDBLOCK == Errno.wouldBlock.rawValue)
#if os(Windows)
XCTAssert(WSAETOOMANYREFS == Errno.tooManyReferences.rawValue)
XCTAssert(WSAEREMOTE == Errno.tooManyRemoteLevels.rawValue)
#else
XCTAssert(ETOOMANYREFS == Errno.tooManyReferences.rawValue)
XCTAssert(EREMOTE == Errno.tooManyRemoteLevels.rawValue)
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
XCTAssert(ENOPOLICY == Errno.noSuchPolicy.rawValue)
#endif
#if !os(Windows)
XCTAssert(ENOTRECOVERABLE == Errno.notRecoverable.rawValue)
XCTAssert(EOWNERDEAD == Errno.previousOwnerDied.rawValue)
#endif
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
XCTAssert(EQFULL == Errno.outputQueueFull.rawValue)
@@ -0,0 +1,25 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
#if SYSTEM_PACKAGE
@testable import SystemPackage
#else
@testable import System
#endif
extension FileDescriptor {
internal func fileSize(
retryOnInterrupt: Bool = true
) throws -> Int64 {
let current = try seek(offset: 0, from: .current)
let size = try seek(offset: 0, from: .end)
try seek(offset: current, from: .start)
return size
}
}
+66 -1
View File
@@ -15,7 +15,7 @@ import SystemPackage
import System
#endif
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
final class FileOperationsTest: XCTestCase {
func testSyscalls() {
let fd = FileDescriptor(rawValue: 1)
@@ -89,6 +89,27 @@ final class FileOperationsTest: XCTestCase {
func testHelpers() {
// TODO: Test writeAll, writeAll(toAbsoluteOffset), closeAfter
}
#if !os(Windows)
func testAdHocPipe() throws {
// Ad-hoc test testing `Pipe` functionality.
// We cannot test `Pipe` using `MockTestCase` because it calls `pipe` with a pointer to an array local to the `Pipe`, the address of which we do not know prior to invoking `Pipe`.
let pipe = try FileDescriptor.pipe()
try pipe.readEnd.closeAfter {
try pipe.writeEnd.closeAfter {
var abc = "abc"
try abc.withUTF8 {
_ = try pipe.writeEnd.write(UnsafeRawBufferPointer($0))
}
let readLen = 3
let readBytes = try Array<UInt8>(unsafeUninitializedCapacity: readLen) { buf, count in
count = try pipe.readEnd.read(into: UnsafeMutableRawBufferPointer(buf))
}
XCTAssertEqual(readBytes, Array(abc.utf8))
}
}
}
#endif
func testAdHocOpen() {
// Ad-hoc test touching a file system.
@@ -139,5 +160,49 @@ final class FileOperationsTest: XCTestCase {
issue26.runAllTests()
}
#if !os(Windows)
func testResizeFile() throws {
let fd = try FileDescriptor.open("/tmp/\(UUID().uuidString).txt", .readWrite, options: [.create, .truncate], permissions: .ownerReadWrite)
try fd.closeAfter {
// File should be empty initially.
XCTAssertEqual(try fd.fileSize(), 0)
// Write 3 bytes.
try fd.writeAll("abc".utf8)
// File should now be 3 bytes.
XCTAssertEqual(try fd.fileSize(), 3)
// Resize to 6 bytes.
try fd.resize(to: 6)
// File should now be 6 bytes.
XCTAssertEqual(try fd.fileSize(), 6)
// Read in the 6 bytes.
let readBytes = try Array<UInt8>(unsafeUninitializedCapacity: 6) { (buf, count) in
try fd.seek(offset: 0, from: .start)
// Should have read all 6 bytes.
count = try fd.read(into: UnsafeMutableRawBufferPointer(buf))
XCTAssertEqual(count, 6)
}
// First 3 bytes should be unaffected by resize.
XCTAssertEqual(Array(readBytes[..<3]), Array("abc".utf8))
// Extension should be padded with zeros.
XCTAssertEqual(Array(readBytes[3...]), Array(repeating: 0, count: 3))
// File should still be 6 bytes.
XCTAssertEqual(try fd.fileSize(), 6)
// Resize to 2 bytes.
try fd.resize(to: 2)
// File should now be 2 bytes.
XCTAssertEqual(try fd.fileSize(), 2)
// Read in file with a buffer big enough for 6 bytes.
let readBytesAfterTruncation = try Array<UInt8>(unsafeUninitializedCapacity: 6) { (buf, count) in
try fd.seek(offset: 0, from: .start)
count = try fd.read(into: UnsafeMutableRawBufferPointer(buf))
// Should only have read 2 bytes.
XCTAssertEqual(count, 2)
}
// Written content was trunctated.
XCTAssertEqual(readBytesAfterTruncation, Array("ab".utf8))
}
}
#endif
}
@@ -15,7 +15,7 @@ import XCTest
@testable import System
#endif
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
struct TestPathComponents: TestCase {
var path: FilePath
var expectedRoot: FilePath.Root?
@@ -100,7 +100,7 @@ struct TestPathComponents: TestCase {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
final class FilePathComponentsTest: XCTestCase {
func testAdHocRRC() {
var path: FilePath = "/usr/local/bin"
@@ -6,7 +6,7 @@
#endif
// Why can't I write this extension on `FilePath.ComponentView.SubSequence`?
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension Slice where Base == FilePath.ComponentView {
internal var _storageSlice: SystemString.SubSequence {
base._path._storage[self.startIndex._storage ..< self.endIndex._storage]
@@ -15,7 +15,7 @@ extension Slice where Base == FilePath.ComponentView {
// Proposed API that didn't make the cut, but we stil want to keep our testing for
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension FilePath {
/// Returns `self` relative to `base`.
/// This does not cosult the file system or resolve symlinks.
@@ -51,7 +51,6 @@ extension FilePath {
/// Whether a lexically-normalized `self` contains a lexically-normalized
/// `other`.
///
public func lexicallyContains(_ other: FilePath) -> Bool {
guard !other.isEmpty else { return true }
guard !isEmpty else { return false }
@@ -68,7 +68,7 @@ extension ParsingTestCase {
@testable import System
#endif
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
final class FilePathParsingTest: XCTestCase {
func testNormalization() {
let unixPaths: Array<ParsingTestCase> = [
@@ -146,7 +146,7 @@ extension SyntaxTestCase {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension SyntaxTestCase {
func testComponents(_ path: FilePath, expected: [String]) {
let expectedComponents = expected.map { FilePath.Component($0)! }
@@ -342,7 +342,7 @@ private struct WindowsRootTestCase: TestCase {
var line: UInt
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
extension WindowsRootTestCase {
func runAllTests() {
withWindowsPaths(enabled: true) {
@@ -357,7 +357,7 @@ extension WindowsRootTestCase {
}
}
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
final class FilePathSyntaxTest: XCTestCase {
func testPathSyntax() {
let unixPaths: Array<SyntaxTestCase> = [
@@ -15,19 +15,21 @@ import SystemPackage
import System
#endif
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
func filePathFromUnterminatedBytes<S: Sequence>(_ bytes: S) -> FilePath where S.Element == UInt8 {
var array = Array(bytes)
assert(array.last != 0, "already null terminated")
array += [0]
return array.withUnsafeBufferPointer {
FilePath(platformString: $0.baseAddress!._asCChar)
$0.withMemoryRebound(to: CChar.self) {
FilePath(platformString: $0.baseAddress!)
}
}
}
let invalidBytes: [UInt8] = [0x2F, 0x61, 0x2F, 0x62, 0x2F, 0x83]
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
final class FilePathTest: XCTestCase {
struct TestPath {
let filePath: FilePath
@@ -67,7 +69,11 @@ final class FilePathTest: XCTestCase {
}
testPath.filePath.withPlatformString {
#if os(Windows)
XCTAssertEqual(testPath.string, String(decodingCString: $0, as: UTF16.self))
#else
XCTAssertEqual(testPath.string, String(cString: $0))
#endif
XCTAssertEqual(testPath.filePath, FilePath(platformString: $0))
}
}
+6 -2
View File
@@ -15,7 +15,7 @@ import SystemPackage
import System
#endif
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
final class FileDescriptorTest: XCTestCase {
func testStandardDescriptors() {
XCTAssertEqual(FileDescriptor.standardInput.rawValue, 0)
@@ -29,13 +29,17 @@ final class FileDescriptorTest: XCTestCase {
XCTAssertEqual(O_WRONLY, FileDescriptor.AccessMode.writeOnly.rawValue)
XCTAssertEqual(O_RDWR, FileDescriptor.AccessMode.readWrite.rawValue)
#if !os(Windows)
XCTAssertEqual(O_NONBLOCK, FileDescriptor.OpenOptions.nonBlocking.rawValue)
#endif
XCTAssertEqual(O_APPEND, FileDescriptor.OpenOptions.append.rawValue)
XCTAssertEqual(O_CREAT, FileDescriptor.OpenOptions.create.rawValue)
XCTAssertEqual(O_TRUNC, FileDescriptor.OpenOptions.truncate.rawValue)
XCTAssertEqual(O_EXCL, FileDescriptor.OpenOptions.exclusiveCreate.rawValue)
#if !os(Windows)
XCTAssertEqual(O_NOFOLLOW, FileDescriptor.OpenOptions.noFollow.rawValue)
XCTAssertEqual(O_CLOEXEC, FileDescriptor.OpenOptions.closeOnExec.rawValue)
#endif
// BSD only
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
@@ -60,7 +64,7 @@ final class FileDescriptorTest: XCTestCase {
}
// @available(macOS 10.16, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
@available(/*System 0.0.1: macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0*/iOS 8, *)
final class FilePermissionsTest: XCTestCase {
func testPermissions() {
+151
View File
@@ -0,0 +1,151 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2022 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
#if swift(>=5.8) && $MoveOnly && (os(macOS) || os(iOS) || os(watchOS) || os(tvOS))
import XCTest
import Darwin.Mach
final class MachPortTests: XCTestCase {
func refCountForMachPortName(name:mach_port_name_t, kind:mach_port_right_t) -> mach_port_urefs_t {
var refCount:mach_port_urefs_t = 0
withUnsafeMutablePointer(to: &refCount) { refCount in
let kr = mach_port_get_refs(mach_task_self_, name, kind, refCount)
assert(kr == KERN_SUCCESS)
}
return refCount
}
func scopedReceiveRight(name:mach_port_name_t) -> mach_port_urefs_t {
_ = Mach.Port<Mach.ReceiveRight>(name:name) // this should automatically deallocate when going out of scope
return refCountForMachPortName(name:name, kind:MACH_PORT_RIGHT_RECEIVE)
}
func testRecieveRightDeallocation() throws {
var name:mach_port_name_t = 0 // Never read
withUnsafeMutablePointer(to:&name) { name in
let kr = mach_port_allocate(mach_task_self_, MACH_PORT_RIGHT_RECEIVE, name)
assert(kr == KERN_SUCCESS)
}
XCTAssert(name != 0xFFFFFFFF)
let one = scopedReceiveRight(name:name)
let zero = refCountForMachPortName(name:name, kind: MACH_PORT_RIGHT_RECEIVE)
XCTAssert(one == 1);
XCTAssert(zero == 0);
}
func consumeSendRightAutomatically(name:mach_port_name_t) -> mach_port_urefs_t {
let send = Mach.Port<Mach.SendRight>(name:name) // this should automatically deallocate when going out of scope
return send.withBorrowedName { name in
// Get the ref count before automatic deallocation happens
return refCountForMachPortName(name:name, kind:MACH_PORT_RIGHT_SEND)
}
}
func testSendRightDeallocation() throws {
let recv = Mach.Port<Mach.ReceiveRight>()
recv.withBorrowedName { name in
let kr = mach_port_insert_right(mach_task_self_, name, name, mach_msg_type_name_t(MACH_MSG_TYPE_MAKE_SEND))
XCTAssert(kr == KERN_SUCCESS)
let one = consumeSendRightAutomatically(name:name)
XCTAssert(one == 1);
let zero = refCountForMachPortName(name:name, kind:MACH_PORT_RIGHT_SEND)
XCTAssert(zero == 0);
}
}
func testSendRightRelinquishment() throws {
let recv = Mach.Port<Mach.ReceiveRight>()
let name = ({
let send = recv.makeSendRight()
let one = send.withBorrowedName { name in
return self.refCountForMachPortName(name:name, kind:MACH_PORT_RIGHT_SEND)
}
XCTAssert(one == 1)
return send.relinquish()
})()
let stillOne = refCountForMachPortName(name:name, kind:MACH_PORT_RIGHT_SEND)
XCTAssert(stillOne == 1)
}
func testMakeSendCountSettable() throws {
var recv = Mach.Port<Mach.ReceiveRight>()
XCTAssert(recv.makeSendCount == 0)
recv.makeSendCount = 7
XCTAssert(recv.makeSendCount == 7)
}
func makeSendRight() throws -> Mach.Port<Mach.SendRight> {
let recv = Mach.Port<Mach.ReceiveRight>()
let zero = recv.makeSendCount
XCTAssert(zero == 0)
let send = recv.makeSendRight()
let one = recv.makeSendCount
XCTAssert(one == 1)
return send
}
func testMakeSendCountIncrement() throws {
_ = try makeSendRight()
}
func testMakeSendOnceDoesntIncrementMakeSendCount() throws {
let recv = Mach.Port<Mach.ReceiveRight>()
let zero = recv.makeSendCount
XCTAssert(zero == 0)
_ = recv.makeSendOnceRight()
let same = recv.makeSendCount
XCTAssert(same == zero)
}
func testMakeSendOnceIsUnique() throws {
let recv = Mach.Port<Mach.ReceiveRight>()
let once = recv.makeSendOnceRight()
recv.withBorrowedName { rname in
once.withBorrowedName { oname in
print(oname, rname)
XCTAssert(oname != rname)
}
}
}
func testMakePair() throws {
let (recv, send) = Mach.allocatePortRightPair()
XCTAssert(recv.makeSendCount == 1)
recv.withBorrowedName { rName in
send.withBorrowedName { sName in
XCTAssert(rName != 0xFFFFFFFF)
XCTAssert(rName != MACH_PORT_NULL)
// send and recv port names coalesce
XCTAssert(rName == sName)
}
}
}
func testCopySend() throws {
let recv = Mach.Port<Mach.ReceiveRight>()
let zero = recv.makeSendCount
XCTAssert(zero == 0)
let send = recv.makeSendRight()
let one = recv.makeSendCount
XCTAssert(one == 1)
_ = try send.copySendRight()
let same = recv.makeSendCount
XCTAssert(same == one)
}
}
#endif
+1 -1
View File
@@ -15,7 +15,7 @@ import XCTest
@testable import System
#endif
// @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
final class MockingTest: XCTestCase {
func testMocking() {
XCTAssertFalse(mockingEnabled)
+39
View File
@@ -0,0 +1,39 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2020 - 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
import XCTest
#if SYSTEM_PACKAGE
@testable import SystemPackage
#else
@testable import System
#endif
final class SystemCharTest: XCTestCase {
func testIsLetter() {
let valid = SystemString(
"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ")
for char in valid {
XCTAssertTrue(char.isLetter)
}
// non printable
for value in 0..<(UInt8(ascii: " ")) {
XCTAssertFalse(SystemChar(codeUnit: CInterop.PlatformUnicodeEncoding.CodeUnit(value)).isLetter)
}
XCTAssertFalse(SystemChar(codeUnit: 0x7F).isLetter) // DEL
// misc other
let invalid = SystemString(
##" !"#$%&'()*+,-./0123456789:;<=>?@[\]^_`{|}~"##)
for char in invalid {
XCTAssertFalse(char.isLetter)
}
}
}
+167 -24
View File
@@ -10,29 +10,6 @@
// Tests for PlatformString, SystemString, and FilePath's forwarding APIs
// TODO: Adapt test to Windows
extension UnsafePointer where Pointee == UInt8 {
internal var _asCChar: UnsafePointer<CChar> {
UnsafeRawPointer(self).assumingMemoryBound(to: CChar.self)
}
}
extension UnsafePointer where Pointee == CChar {
internal var _asUInt8: UnsafePointer<UInt8> {
UnsafeRawPointer(self).assumingMemoryBound(to: UInt8.self)
}
}
extension UnsafeBufferPointer where Element == UInt8 {
internal var _asCChar: UnsafeBufferPointer<CChar> {
let base = baseAddress?._asCChar
return UnsafeBufferPointer<CChar>(start: base, count: self.count)
}
}
extension UnsafeBufferPointer where Element == CChar {
internal var _asUInt8: UnsafeBufferPointer<UInt8> {
let base = baseAddress?._asUInt8
return UnsafeBufferPointer<UInt8>(start: base, count: self.count)
}
}
import XCTest
@@ -46,7 +23,11 @@ private func makeRaw(
_ str: String
) -> [CInterop.PlatformChar] {
var str = str
var array = str.withUTF8 { Array($0._asCChar) }
#if os(Windows)
var array = Array(str.utf16)
#else
var array = str.withUTF8 { $0.withMemoryRebound(to: CChar.self, Array.init) }
#endif
array.append(0)
return array
}
@@ -275,3 +256,165 @@ final class SystemStringTest: XCTestCase {
}
extension SystemStringTest {
func test_String_initWithArrayConversion() {
let source: [CInterop.PlatformChar] = [0x61, 0x62, 0, 0x63]
let str = String(platformString: source)
source.withUnsafeBufferPointer {
XCTAssertEqual(str, String(platformString: $0.baseAddress!))
}
}
@available(*, deprecated) // silence the warning for using a deprecated api
func test_String_initWithStringConversion() {
let source = "ab\0c"
var str: String
str = String(platformString: source)
source.withPlatformString {
XCTAssertEqual(str, String(platformString: $0))
}
str = String(platformString: "")
XCTAssertEqual(str.isEmpty, true)
}
@available(*, deprecated) // silence the warning for using a deprecated api
func test_String_initWithInoutConversion() {
var c: CInterop.PlatformChar = 0
let str = String(platformString: &c)
// Any other value of `c` would violate the null-terminated precondition
XCTAssertEqual(str.isEmpty, true)
}
func test_String_validatingPlatformStringWithArrayConversion() {
var source: [CInterop.PlatformChar] = [0x61, 0x62, 0, 0x63]
var str: String?
str = String(validatingPlatformString: source)
source.withUnsafeBufferPointer {
XCTAssertEqual(str, String(validatingPlatformString: $0.baseAddress!))
}
source[1] = CInterop.PlatformChar(truncatingIfNeeded: 0xdfff)
str = String(validatingPlatformString: source)
XCTAssertNil(str)
}
@available(*, deprecated) // silence the warning for using a deprecated api
func test_String_validatingPlatformStringWithStringConversion() {
let source = "ab\0c"
var str: String?
str = String(validatingPlatformString: source)
XCTAssertNotNil(str)
source.withPlatformString {
XCTAssertEqual(str, String.init(validatingPlatformString: $0))
}
str = String(validatingPlatformString: "")
XCTAssertNotNil(str)
XCTAssertEqual(str?.isEmpty, true)
}
@available(*, deprecated) // silence the warning for using a deprecated api
func test_String_validatingPlatformStringWithInoutConversion() {
var c: CInterop.PlatformChar = 0
let str = String(validatingPlatformString: &c)
// Any other value of `c` would violate the null-terminated precondition
XCTAssertNotNil(str)
XCTAssertEqual(str?.isEmpty, true)
}
func test_FilePath_initWithArrayConversion() {
let source: [CInterop.PlatformChar] = [0x61, 0x62, 0, 0x63]
let path = FilePath(platformString: source)
source.withUnsafeBufferPointer {
XCTAssertEqual(path, FilePath(platformString: $0.baseAddress!))
}
}
@available(*, deprecated) // silence the warning for using a deprecated api
func test_FilePath_initWithStringConversion() {
let source = "ab\0c"
var path: FilePath
path = FilePath(platformString: source)
source.withPlatformString {
XCTAssertEqual(path, FilePath(platformString: $0))
}
path = FilePath(platformString: "")
XCTAssertEqual(path.string.isEmpty, true)
}
@available(*, deprecated) // silence the warning for using a deprecated api
func test_FilePath_initWithInoutConversion() {
var c: CInterop.PlatformChar = 0
let path = FilePath(platformString: &c)
// Any other value of `c` would violate the null-terminated precondition
XCTAssertEqual(path.string.isEmpty, true)
}
func test_FilePathComponent_initWithArrayConversion() {
var source: [CInterop.PlatformChar] = [0x61, 0x62, 0, 0x63]
var component: FilePath.Component?
component = FilePath.Component(platformString: source)
source.withUnsafeBufferPointer {
XCTAssertEqual(component, .init(platformString: $0.baseAddress!))
}
source[1] = CInterop.PlatformChar(truncatingIfNeeded: 0xffff)
component = FilePath.Component(platformString: source)
source.withUnsafeBufferPointer {
XCTAssertEqual(component, .init(platformString: $0.baseAddress!))
}
}
@available(*, deprecated) // silence the warning for using a deprecated api
func test_FilePathComponent_initWithStringConversion() {
let source = "ab\0c"
var component: FilePath.Component?
component = FilePath.Component(platformString: source)
source.withPlatformString {
XCTAssertEqual(component, FilePath.Component(platformString: $0))
}
component = FilePath.Component(platformString: "")
XCTAssertNil(component)
}
@available(*, deprecated) // silence the warning for using a deprecated api
func test_FilePathComponent_initWithInoutConversion() {
var c: CInterop.PlatformChar = 0
let component = FilePath.Component(platformString: &c)
XCTAssertNil(component)
}
func test_FilePathRoot_initWithArrayConversion() {
let source: [CInterop.PlatformChar]
#if os(Windows)
source = [0x41, 0x3a, 0x5c, 0, 0x7f]
#else // unix
source = [0x2f, 0, 0x7f]
#endif
var root: FilePath.Root?
root = FilePath.Root(platformString: source)
source.withUnsafeBufferPointer {
XCTAssertEqual(root, FilePath.Root(platformString: $0.baseAddress!))
}
}
@available(*, deprecated) // silence the warning for using a deprecated api
func test_FilePathRoot_initWithStringConversion() {
#if os(Windows)
let source = "C:\\\0 and the rest"
#else // unix
let source = "/\0 and the rest"
#endif
var root: FilePath.Root?
root = FilePath.Root(platformString: source)
source.withPlatformString {
XCTAssertEqual(root, FilePath.Root(platformString: $0))
}
root = FilePath.Root(platformString: "")
XCTAssertNil(root)
}
@available(*, deprecated) // silence the warning for using a deprecated api
func test_FilePathRoot_initWithInoutConversion() {
var c: CInterop.PlatformChar = 0
let root = FilePath.Root(platformString: &c)
XCTAssertNil(root)
}
}
+51 -11
View File
@@ -15,6 +15,25 @@ import XCTest
@testable import System
#endif
internal struct Wildcard: Hashable {}
extension Trace.Entry {
/// This implements `==` with wildcard matching.
/// (`Entry` cannot conform to `Equatable`/`Hashable` this way because
/// the wildcard matching `==` relation isn't transitive.)
internal func matches(_ other: Self) -> Bool {
guard self.name == other.name else { return false }
guard self.arguments.count == other.arguments.count else { return false }
for i in self.arguments.indices {
if self.arguments[i] is Wildcard || other.arguments[i] is Wildcard {
continue
}
guard self.arguments[i] == other.arguments[i] else { return false }
}
return true
}
}
// To aid debugging, force failures to fatal error
internal var forceFatalFailures = false
@@ -40,7 +59,7 @@ extension TestCase {
_ message: String? = nil
) where S1.Element: Equatable, S1.Element == S2.Element {
if !expected.elementsEqual(actual) {
defer { print("expected: \(expected), actual: \(actual)") }
defer { print("expected: \(expected)\n actual: \(actual)") }
fail(message)
}
}
@@ -49,7 +68,7 @@ extension TestCase {
_ message: String? = nil
) {
if actual != expected {
defer { print("expected: \(expected), actual: \(actual)") }
defer { print("expected: \(expected)\n actual: \(actual)") }
fail(message)
}
}
@@ -62,6 +81,27 @@ extension TestCase {
fail(message)
}
}
func expectMatch(
_ expected: Trace.Entry?, _ actual: Trace.Entry?,
_ message: String? = nil
) {
func check() -> Bool {
switch (expected, actual) {
case let (expected?, actual?):
return expected.matches(actual)
case (nil, nil):
return true
default:
return false
}
}
if !check() {
let e = expected.map { "\($0)" } ?? "nil"
let a = actual.map { "\($0)" } ?? "nil"
defer { print("expected: \(e)\n actual: \(a)") }
fail(message)
}
}
func expectNil<T>(
_ actual: T?,
_ message: String? = nil
@@ -149,7 +189,7 @@ internal struct MockTestCase: TestCase {
// Test our API mappings to the lower-level syscall invocation
do {
try body(true)
self.expectEqual(self.expected, mocking.trace.dequeue())
self.expectMatch(self.expected, mocking.trace.dequeue())
} catch {
self.fail()
}
@@ -158,9 +198,9 @@ internal struct MockTestCase: TestCase {
guard interruptBehavior != .noError else {
do {
try body(interruptable)
self.expectEqual(self.expected, mocking.trace.dequeue())
self.expectMatch(self.expected, mocking.trace.dequeue())
try body(!interruptable)
self.expectEqual(self.expected, mocking.trace.dequeue())
self.expectMatch(self.expected, mocking.trace.dequeue())
} catch {
self.fail()
}
@@ -177,7 +217,7 @@ internal struct MockTestCase: TestCase {
self.fail()
} catch Errno.interrupted {
// Success!
self.expectEqual(self.expected, mocking.trace.dequeue())
self.expectMatch(self.expected, mocking.trace.dequeue())
} catch {
self.fail()
}
@@ -188,13 +228,13 @@ internal struct MockTestCase: TestCase {
mocking.forceErrno = .counted(errno: EINTR, count: 3)
try body(interruptable)
self.expectEqual(self.expected, mocking.trace.dequeue()) // EINTR
self.expectEqual(self.expected, mocking.trace.dequeue()) // EINTR
self.expectEqual(self.expected, mocking.trace.dequeue()) // EINTR
self.expectEqual(self.expected, mocking.trace.dequeue()) // Success
self.expectMatch(self.expected, mocking.trace.dequeue()) // EINTR
self.expectMatch(self.expected, mocking.trace.dequeue()) // EINTR
self.expectMatch(self.expected, mocking.trace.dequeue()) // EINTR
self.expectMatch(self.expected, mocking.trace.dequeue()) // Success
} catch Errno.interrupted {
self.expectFalse(interruptable)
self.expectEqual(self.expected, mocking.trace.dequeue()) // EINTR
self.expectMatch(self.expected, mocking.trace.dequeue()) // EINTR
} catch {
self.fail()
}
+89
View File
@@ -0,0 +1,89 @@
/*
This source file is part of the Swift System open source project
Copyright (c) 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
*/
import XCTest
#if SYSTEM_PACKAGE
@testable import SystemPackage
#else
@testable import System
#endif
class UtilTests: XCTestCase {
func testStackBuffer() {
// Exercises _withStackBuffer a bit, in hopes any bugs will
// show up as ASan failures.
for size in stride(from: 0, to: 1000, by: 5) {
var called = false
_withStackBuffer(capacity: size) { buffer in
XCTAssertFalse(called)
called = true
buffer.initializeMemory(as: UInt8.self, repeating: 42)
}
XCTAssertTrue(called)
}
}
func testCStringArray() {
func check(
_ array: [String],
file: StaticString = #file,
line: UInt = #line
) {
array._withCStringArray { carray in
let actual = carray.map { $0.map { String(cString: $0) } ?? "<NULL>" }
XCTAssertEqual(actual, array, file: file, line: line)
// Verify that there is a null pointer following the last item in
// carray. (Note: this is intentionally addressing beyond the
// end of the buffer, as the function promises that is going to be okay.)
XCTAssertNil((carray.baseAddress! + carray.count).pointee)
}
}
check([])
check([""])
check(["", ""])
check(["", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", ""])
// String literals of various sizes and counts
check(["hello"])
check(["hello", "world"])
check(["This is a rather large string literal"])
check([
"This is a rather large string literal",
"This is small",
"This one is not that small -- it's even longer than the first",
])
check([
"This is a rather large string literal",
"This one is not that small -- it's even longer than the first",
"And this is the largest of them all. I wonder if it even fits on a line"
])
check(Array(repeating: "", count: 100))
check(Array(repeating: "Hiii", count: 100))
check(["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m"])
check(["", "b", "", "d", "", "f", "", "h", "", "j", "", "👨‍👨‍👧‍👦👩‍❤️‍💋‍👨", "m"])
var girls = ["Dörothy", "Róse", "Blánche", "Sőphia"]
check(girls) // Small strings
for i in girls.indices {
// Convert to native
girls[i] = "\(girls[i]) \(girls[i]) \(girls[i])"
}
check(girls) // Native large strings
for i in girls.indices {
let data = girls[i].data(using: .utf16)!
girls[i] = NSString(
data: data,
encoding: String.Encoding.utf16.rawValue
)! as String
}
check(girls) // UTF-16 Cocoa strings
}
}
+12 -1
View File
@@ -1,4 +1,4 @@
#if !canImport(ObjectiveC)
#if !canImport(ObjectiveC) && swift(<5.5)
import XCTest
extension ErrnoTest {
@@ -27,6 +27,7 @@ extension FileOperationsTest {
// to regenerate.
static let __allTests__FileOperationsTest = [
("testAdHocOpen", testAdHocOpen),
("testAdHocPipe", testAdHocPipe),
("testGithubIssues", testGithubIssues),
("testHelpers", testHelpers),
("testSyscalls", testSyscalls),
@@ -94,6 +95,15 @@ extension MockingTest {
]
}
extension SystemCharTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__SystemCharTest = [
("testIsLetter", testIsLetter),
]
}
extension SystemStringTest {
// DO NOT MODIFY: This is autogenerated, use:
// `swift test --generate-linuxmain`
@@ -115,6 +125,7 @@ public func __allTests() -> [XCTestCaseEntry] {
testCase(FilePathTest.__allTests__FilePathTest),
testCase(FilePermissionsTest.__allTests__FilePermissionsTest),
testCase(MockingTest.__allTests__MockingTest),
testCase(SystemCharTest.__allTests__SystemCharTest),
testCase(SystemStringTest.__allTests__SystemStringTest),
]
}
+116
View File
@@ -0,0 +1,116 @@
#!/usr/bin/env python3
# This script can be used to automatically add/remove `@available` attributes to
# declarations in Swift sources in this package.
#
# In order for this to work, ABI-impacting declarations need to be annotated
# with special comments in the following format:
#
# @available(/*System 0.0.2*/iOS 8, *)
# public func greeting() -> String {
# "Hello"
# }
#
# (The iOS 8 availability is a dummy no-op declaration -- it only has to be
# there because `@available(*)` isn't valid syntax, and commenting out the
# entire `@available` attribute would interfere with parser tools for doc
# comments. `iOS 8` is the shortest version string that matches the minimum
# possible deployment target for Swift code, so we use that as our dummy
# availability version. `@available(iOS 8, *)` is functionally equivalent to not
# having an `@available` attribute at all.)
#
# The script adds full availability incantations to these comments. It can run
# in one of two modes:
#
# By default, `expand-availability.py` expands availability macros within the
# comments. This is useful during package development to cross-reference
# availability across `SystemPackage` and the ABI-stable `System` module that
# ships in Apple's OS releases:
#
# @available(/*System 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
# public func greeting() -> String {
# "Hello"
# }
#
# `expand-availability.py --attributes` adds actual availability declarations.
# This is used by maintainers to build ABI stable releases of System on Apple's
# platforms:
#
# @available(/*System 0.0.2: */macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
# public func greeting() -> String {
# "Hello"
# }
#
# The script recognizes all three forms of these annotations and updates them on
# every run, so we can run the script to enable/disable attributes as needed.
import os
import os.path
import fileinput
import re
import sys
import argparse
versions = {
"System 0.0.1": "macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0",
"System 0.0.2": "macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0",
"System 1.1.0": "macOS 9999, iOS 9999, watchOS 9999, tvOS 9999",
"System 1.2.0": "macOS 9999, iOS 9999, watchOS 9999, tvOS 9999",
"System 1.3.0": "macOS 9999, iOS 9999, watchOS 9999, tvOS 9999",
}
parser = argparse.ArgumentParser(description="Expand availability macros.")
parser.add_argument("--attributes", help="Add @available attributes",
action="store_true")
args = parser.parse_args()
def swift_sources_in(path):
result = []
for (dir, _, files) in os.walk(path):
for file in files:
extension = os.path.splitext(file)[1]
if extension == ".swift":
result.append(os.path.join(dir, file))
return result
# Old-style syntax:
# /*System 0.0.2*/
# /*System 0.0.2, @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)*/
# /*System 0.0.2*/@available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
old_macro_pattern = re.compile(
r"/\*(System [^ *]+)(, @available\([^)]*\))?\*/(@available\([^)]*\))?")
# New-style comments:
# @available(/*SwiftSystem 0.0.2*/macOS 10, *)
# @available(/*SwiftSystem 0.0.2: macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0*/iOS 8, *)
# @available(/*SwiftSystem 0.0.2*/macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
#
# These do not interfere with our tools' ability to find doc comments.
macro_pattern = re.compile(
r"@available\(/\*(System [^ *:]+)[^*/)]*\*/([^)]*)\*\)")
def available_attribute(filename, lineno, symbolic_version):
expansion = versions[symbolic_version]
if expansion is None:
raise ValueError("{0}:{1}: error: Unknown System version '{0}'"
.format(fileinput.filename(), fileinput.lineno(), symbolic_version))
if args.attributes:
attribute = "@available(/*{0}*/{1}, *)".format(symbolic_version, expansion)
else:
# Sadly `@available(*)` is not valid syntax, so we have to mention at
# least one actual platform here.
attribute = "@available(/*{0}: {1}*/iOS 8, *)".format(symbolic_version, expansion)
return attribute
sources = swift_sources_in("Sources") + swift_sources_in("Tests")
for line in fileinput.input(files=sources, inplace=True):
match = re.search(macro_pattern, line)
if match is None:
match = re.search(old_macro_pattern, line)
if match:
symbolic_version = match.group(1)
replacement = available_attribute(
fileinput.filename(), fileinput.lineno(), symbolic_version)
line = line[:match.start()] + replacement + line[match.end():]
print(line, end="")
+19
View File
@@ -0,0 +1,19 @@
#[[
This source file is part of the Swift System open source Project
Copyright (c) 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
#]]
set(SWIFT_SYSTEM_EXPORTS_FILE ${CMAKE_CURRENT_BINARY_DIR}/SwiftSystemExports.cmake)
configure_file(SwiftSystemConfig.cmake.in
${CMAKE_CURRENT_BINARY_DIR}/SwiftSystemConfig.cmake)
get_property(SWIFT_SYSTEM_EXPORTS GLOBAL PROPERTY SWIFT_SYSTEM_EXPORTS)
export(TARGETS ${SWIFT_SYSTEM_EXPORTS}
NAMESPACE SwiftSystem::
FILE ${SWIFT_SYSTEM_EXPORTS_FILE}
EXPORT_LINK_INTERFACE_LIBRARIES)
+8 -2
View File
@@ -17,8 +17,12 @@ See https://swift.org/LICENSE.txt for license information
function(get_swift_host_arch result_var_name)
if("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "x86_64")
set("${result_var_name}" "x86_64" PARENT_SCOPE)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "aarch64")
set("${result_var_name}" "aarch64" PARENT_SCOPE)
elseif ("${CMAKE_SYSTEM_PROCESSOR}" MATCHES "AArch64|aarch64|arm64|ARM64")
if(CMAKE_SYSTEM_NAME MATCHES Darwin)
set("${result_var_name}" "arm64" PARENT_SCOPE)
else()
set("${result_var_name}" "aarch64" PARENT_SCOPE)
endif()
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "ppc64")
set("${result_var_name}" "powerpc64" PARENT_SCOPE)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "ppc64le")
@@ -31,6 +35,8 @@ function(get_swift_host_arch result_var_name)
set("${result_var_name}" "armv7" PARENT_SCOPE)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "armv7-a")
set("${result_var_name}" "armv7" PARENT_SCOPE)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "amd64")
set("${result_var_name}" "amd64" PARENT_SCOPE)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "AMD64")
set("${result_var_name}" "x86_64" PARENT_SCOPE)
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "IA64")
+12
View File
@@ -0,0 +1,12 @@
#[[
This source file is part of the Swift System open source Project
Copyright (c) 2021 Apple Inc. and the Swift System project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
#]]
if(NOT TARGET SystemPackage)
include("@SWIFT_SYSTEM_EXPORTS_FILE@")
endif()