Skip to content

[stdlib] properly rename validatingUTF8 to validatingCString #71363

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 7, 2024
Merged

[stdlib] properly rename validatingUTF8 to validatingCString #71363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da5b41a
[stdlib] properly rename validatingUTF8 to validatingCString
glessard Feb 3, 2024
16af5e6
[test] silence api-digester false alarm
glessard Feb 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions stdlib/public/core/CString.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,11 +186,16 @@ extension String {
///
/// - Parameter nullTerminatedUTF8:
/// A pointer to a null-terminated sequence of UTF-8 code units.
@inlinable
@_alwaysEmitIntoClient
@_silgen_name("$sSS14validatingUTF8SSSgSPys4Int8VG_tcfC")
public init?(validatingCString nullTerminatedUTF8: UnsafePointer<CChar>) {
// FIXME: https://github.com/apple/swift/issues/68433 (rdar://115296219)
self.init(validatingUTF8: nullTerminatedUTF8)
let len = UTF8._nullCodeUnitOffset(in: nullTerminatedUTF8)
let validated = nullTerminatedUTF8.withMemoryRebound(
to: UInt8.self,
capacity: len,
{ String._tryFromUTF8(UnsafeBufferPointer(start: $0, count: len)) }
)
guard let validated else { return nil }
self = validated
}

/// Creates a new string by copying and validating the null-terminated UTF-8
Expand Down Expand Up @@ -223,15 +228,12 @@ extension String {
///
/// - Parameter cString:
/// A pointer to a null-terminated sequence of UTF-8 code units.
@inlinable
@_alwaysEmitIntoClient
@available(swift, deprecated: 6, renamed: "String.init(validatingCString:)")
@_silgen_name("_swift_se0405_String_validatingUTF8")
public init?(validatingUTF8 cString: UnsafePointer<CChar>) {
let len = UTF8._nullCodeUnitOffset(in: cString)
guard let str = cString.withMemoryRebound(to: UInt8.self, capacity: len, {
String._tryFromUTF8(UnsafeBufferPointer(start: $0, count: len))
})
else { return nil }

self = str
self.init(validatingCString: cString)
}

/// Creates a new string by copying and validating the null-terminated UTF-8
Expand Down
6 changes: 6 additions & 0 deletions test/api-digester/stability-stdlib-abi-without-asserts.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,12 @@ Func UnsafeMutablePointer.moveUpdate(from:count:) is a new API without @availabl
Func UnsafeMutableBufferPointer.initialize(from:) has mangled name changing from 'Swift.UnsafeMutableBufferPointer.initialize<A where A == A1.Element, A1: Swift.Sequence>(from: A1) -> (A1.Iterator, Swift.Int)' to 'Swift.UnsafeMutableBufferPointer.initialize<A where A == A1.Element, A1: Swift.Sequence>(from: A1) -> (unwritten: A1.Iterator, index: Swift.Int)'
Func UnsafeMutableBufferPointer.initialize(from:) has return type change from (τ_1_0.Iterator, Swift.Int) to (unwritten: τ_1_0.Iterator, index: Swift.Int)

// This hasn't actually been removed; it was renamed at the source level while
// retaining its old mangled/silgen name. The old source-level name is preserved
// as an @_alwaysEmitIntoClient function. The source break was accepted as part of se-0405.
Constructor String.init(validatingCString:) is a new API without @available attribute
Constructor String.init(validatingUTF8:) has been removed

// These haven't actually been removed; they are simply marked unavailable.
// This seems to be a false positive in the ABI checker. This is not an ABI
// break because the symbols are still present.
Expand Down