-
Notifications
You must be signed in to change notification settings - Fork 209
Implement AttributedString UTF8 and UTF16 views #1066
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.
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
135 changes: 135 additions & 0 deletions
135
Sources/FoundationEssentials/AttributedString/AttributedString+UTF16View.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift.org open source project | ||
| // | ||
| // Copyright (c) 2024 Apple Inc. and the Swift project authors | ||
| // Licensed under Apache License v2.0 with Runtime Library Exception | ||
| // | ||
| // See https://swift.org/LICENSE.txt for license information | ||
| // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| #if FOUNDATION_FRAMEWORK | ||
| @_spi(Unstable) internal import CollectionsInternal | ||
| #elseif canImport(_RopeModule) | ||
| internal import _RopeModule | ||
| #elseif canImport(_FoundationCollections) | ||
| internal import _FoundationCollections | ||
| #endif | ||
|
|
||
| @available(FoundationPreview 6.2, *) | ||
| extension AttributedString { | ||
| public struct UTF16View: Sendable { | ||
| internal var _guts: Guts | ||
| internal var _range: Range<BigString.Index> | ||
| internal var _identity: Int = 0 | ||
|
|
||
| internal init(_ guts: AttributedString.Guts) { | ||
| self.init(guts, in: guts.stringBounds) | ||
| } | ||
|
|
||
| internal init(_ guts: Guts, in range: Range<BigString.Index>) { | ||
| _guts = guts | ||
| _range = range | ||
| } | ||
| } | ||
|
|
||
| public var utf16: UTF16View { | ||
| UTF16View(_guts) | ||
| } | ||
| } | ||
|
|
||
| @available(FoundationPreview 6.2, *) | ||
| extension AttributedSubstring { | ||
| public var utf16: AttributedString.UTF16View { | ||
| AttributedString.UTF16View(_guts, in: _range) | ||
| } | ||
| } | ||
|
|
||
| @available(FoundationPreview 6.2, *) | ||
| extension AttributedString.UTF16View { | ||
| var _utf16: BigSubstring.UTF16View { | ||
| BigSubstring.UTF16View(_unchecked: _guts.string, in: _range) | ||
| } | ||
| } | ||
|
|
||
| @available(FoundationPreview 6.2, *) | ||
| extension AttributedString.UTF16View: BidirectionalCollection { | ||
| public typealias Element = UTF16.CodeUnit | ||
| public typealias Index = AttributedString.Index | ||
| public typealias Subsequence = Self | ||
|
|
||
| public var startIndex: AttributedString.Index { | ||
| .init(_range.lowerBound) | ||
| } | ||
|
|
||
| public var endIndex: AttributedString.Index { | ||
| .init(_range.upperBound) | ||
| } | ||
|
|
||
| public var count: Int { | ||
| _utf16.count | ||
| } | ||
|
|
||
| public func index(before i: AttributedString.Index) -> AttributedString.Index { | ||
| precondition(i > startIndex && i <= endIndex, "AttributedString index out of bounds") | ||
| let j = Index(_guts.string.utf16.index(before: i._value)) | ||
| precondition(j >= startIndex, "Can't advance AttributedString index before start index") | ||
| return j | ||
| } | ||
|
|
||
| public func index(after i: AttributedString.Index) -> AttributedString.Index { | ||
| precondition(i >= startIndex && i < endIndex, "AttributedString index out of bounds") | ||
| let j = Index(_guts.string.utf16.index(after: i._value)) | ||
| precondition(j <= endIndex, "Can't advance AttributedString index after end index") | ||
| return j | ||
| } | ||
|
|
||
| public func index(_ i: AttributedString.Index, offsetBy distance: Int) -> AttributedString.Index { | ||
| precondition(i >= startIndex && i <= endIndex, "AttributedString index out of bounds") | ||
| let j = Index(_guts.string.utf16.index(i._value, offsetBy: distance)) | ||
| precondition(j >= startIndex && j <= endIndex, "AttributedString index out of bounds") | ||
| return j | ||
| } | ||
|
|
||
| public func index( | ||
| _ i: AttributedString.Index, | ||
| offsetBy distance: Int, | ||
| limitedBy limit: AttributedString.Index | ||
| ) -> AttributedString.Index? { | ||
| precondition(i >= startIndex && i <= endIndex, "AttributedString index out of bounds") | ||
| precondition(limit >= startIndex && limit <= endIndex, "AttributedString index out of bounds") | ||
| guard let j = _guts.string.utf16.index( | ||
| i._value, offsetBy: distance, limitedBy: limit._value | ||
| ) else { | ||
| return nil | ||
| } | ||
| precondition(j >= startIndex._value && j <= endIndex._value, | ||
| "AttributedString index out of bounds") | ||
| return Index(j) | ||
| } | ||
|
|
||
| public func distance( | ||
| from start: AttributedString.Index, | ||
| to end: AttributedString.Index | ||
| ) -> Int { | ||
| precondition(start >= startIndex && start <= endIndex, "AttributedString index out of bounds") | ||
| precondition(end >= startIndex && end <= endIndex, "AttributedString index out of bounds") | ||
| return _guts.string.utf16.distance(from: start._value, to: end._value) | ||
| } | ||
|
|
||
| public subscript(index: AttributedString.Index) -> UTF16.CodeUnit { | ||
| precondition(index >= startIndex && index < endIndex, "AttributedString index out of bounds") | ||
| return _guts.string.utf16[index._value] | ||
| } | ||
|
|
||
| public subscript(bounds: Range<AttributedString.Index>) -> Self { | ||
| let bounds = bounds._bstringRange | ||
| precondition( | ||
| bounds.lowerBound >= _range.lowerBound && bounds.lowerBound <= _range.upperBound && | ||
| bounds.upperBound >= _range.lowerBound && bounds.upperBound <= _range.upperBound, | ||
| "AttributedString index range out of bounds") | ||
| return Self(_guts, in: bounds) | ||
| } | ||
| } |
135 changes: 135 additions & 0 deletions
135
Sources/FoundationEssentials/AttributedString/AttributedString+UTF8View.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift.org open source project | ||
| // | ||
| // Copyright (c) 2024 Apple Inc. and the Swift project authors | ||
| // Licensed under Apache License v2.0 with Runtime Library Exception | ||
| // | ||
| // See https://swift.org/LICENSE.txt for license information | ||
| // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| #if FOUNDATION_FRAMEWORK | ||
| @_spi(Unstable) internal import CollectionsInternal | ||
| #elseif canImport(_RopeModule) | ||
| internal import _RopeModule | ||
| #elseif canImport(_FoundationCollections) | ||
| internal import _FoundationCollections | ||
| #endif | ||
|
|
||
| @available(FoundationPreview 6.2, *) | ||
| extension AttributedString { | ||
| public struct UTF8View: Sendable { | ||
| internal var _guts: Guts | ||
| internal var _range: Range<BigString.Index> | ||
| internal var _identity: Int = 0 | ||
|
|
||
| internal init(_ guts: AttributedString.Guts) { | ||
| self.init(guts, in: guts.stringBounds) | ||
| } | ||
|
|
||
| internal init(_ guts: Guts, in range: Range<BigString.Index>) { | ||
| _guts = guts | ||
| _range = range | ||
| } | ||
| } | ||
|
|
||
| public var utf8: UTF8View { | ||
| UTF8View(_guts) | ||
| } | ||
| } | ||
|
|
||
| @available(FoundationPreview 6.2, *) | ||
| extension AttributedSubstring { | ||
| public var utf8: AttributedString.UTF8View { | ||
| AttributedString.UTF8View(_guts, in: _range) | ||
| } | ||
| } | ||
|
|
||
| @available(FoundationPreview 6.2, *) | ||
| extension AttributedString.UTF8View { | ||
| var _utf8: BigSubstring.UTF8View { | ||
| BigSubstring.UTF8View(_unchecked: _guts.string, in: _range) | ||
| } | ||
| } | ||
|
|
||
| @available(FoundationPreview 6.2, *) | ||
| extension AttributedString.UTF8View: BidirectionalCollection { | ||
| public typealias Element = UTF8.CodeUnit | ||
| public typealias Index = AttributedString.Index | ||
| public typealias Subsequence = Self | ||
|
|
||
| public var startIndex: AttributedString.Index { | ||
| .init(_range.lowerBound) | ||
| } | ||
|
|
||
| public var endIndex: AttributedString.Index { | ||
| .init(_range.upperBound) | ||
| } | ||
|
|
||
| public var count: Int { | ||
| _utf8.count | ||
| } | ||
|
|
||
| public func index(before i: AttributedString.Index) -> AttributedString.Index { | ||
| precondition(i > startIndex && i <= endIndex, "AttributedString index out of bounds") | ||
| let j = Index(_guts.string.utf8.index(before: i._value)) | ||
| precondition(j >= startIndex, "Can't advance AttributedString index before start index") | ||
| return j | ||
| } | ||
|
|
||
| public func index(after i: AttributedString.Index) -> AttributedString.Index { | ||
| precondition(i >= startIndex && i < endIndex, "AttributedString index out of bounds") | ||
| let j = Index(_guts.string.utf8.index(after: i._value)) | ||
| precondition(j <= endIndex, "Can't advance AttributedString index after end index") | ||
| return j | ||
| } | ||
|
|
||
| public func index(_ i: AttributedString.Index, offsetBy distance: Int) -> AttributedString.Index { | ||
| precondition(i >= startIndex && i <= endIndex, "AttributedString index out of bounds") | ||
| let j = Index(_guts.string.utf8.index(i._value, offsetBy: distance)) | ||
| precondition(j >= startIndex && j <= endIndex, "AttributedString index out of bounds") | ||
| return j | ||
| } | ||
|
|
||
| public func index( | ||
| _ i: AttributedString.Index, | ||
| offsetBy distance: Int, | ||
| limitedBy limit: AttributedString.Index | ||
| ) -> AttributedString.Index? { | ||
| precondition(i >= startIndex && i <= endIndex, "AttributedString index out of bounds") | ||
| precondition(limit >= startIndex && limit <= endIndex, "AttributedString index out of bounds") | ||
| guard let j = _guts.string.utf8.index( | ||
| i._value, offsetBy: distance, limitedBy: limit._value | ||
| ) else { | ||
| return nil | ||
| } | ||
| precondition(j >= startIndex._value && j <= endIndex._value, | ||
| "AttributedString index out of bounds") | ||
| return Index(j) | ||
| } | ||
|
|
||
| public func distance( | ||
| from start: AttributedString.Index, | ||
| to end: AttributedString.Index | ||
| ) -> Int { | ||
| precondition(start >= startIndex && start <= endIndex, "AttributedString index out of bounds") | ||
| precondition(end >= startIndex && end <= endIndex, "AttributedString index out of bounds") | ||
| return _guts.string.utf8.distance(from: start._value, to: end._value) | ||
| } | ||
|
|
||
| public subscript(index: AttributedString.Index) -> UTF8.CodeUnit { | ||
| precondition(index >= startIndex && index < endIndex, "AttributedString index out of bounds") | ||
| return _guts.string.utf8[index._value] | ||
| } | ||
|
|
||
| public subscript(bounds: Range<AttributedString.Index>) -> Self { | ||
| let bounds = bounds._bstringRange | ||
| precondition( | ||
| bounds.lowerBound >= _range.lowerBound && bounds.lowerBound <= _range.upperBound && | ||
| bounds.upperBound >= _range.lowerBound && bounds.upperBound <= _range.upperBound, | ||
| "AttributedString index range out of bounds") | ||
| return Self(_guts, in: bounds) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this throw if
i == startIndex? I believe callingstring.utf8.index(before: string.utf8.startIndex)throws the index out of bound error. If so, should we just enforce this at the precondition above?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We still do hit a precondition from swift-collections:
But we might as well account for this here, good call - I'll update the above
>=to be>