Karoy Lorentey 06ea8b042f
Start using Rope for attribute run storage (#166)
* rdar://108152217 Start using Rope for attribute run storage

- Replace `Array<_InternalRun>` with `Rope<_InternalRun>`.
- Fix semantics of AttributeRunBoundaries.character. It no longer pretends that attributes can be tied to grapheme clusters — that never actually worked properly, and it cannot be supported without breaking the intended use case.
- Remove cache of latest run position; log(n) might be fast enough that we don’t need to worry about that.
- Switch AttributedString.Guts members to take/return BigString.Index values, not AttributedString indices. This cuts down on constant back-and-forth conversions.
- Discard unused Guts members; update remaining mutation methods to follow Swift naming conventions.
- Stop using the `public extension` language misfeature.

* rdar://108152217 Apply notes from code review

AttributedString.CharacterView and AttributedString.UnicodeScalarView
did not use the right semantics in the case when the underlying text
was not touched. It’s okay in that case to not mutate text storage,
but we still want to override the attributes within the subrange as if
the client actually did replace text — as in, we want to use precisely
the same attribute storage for the range on both paths.

Also, make sure we correctly enforce attribute constraints in the
`!hasStringChanges` case, in both views.

* rdar://108152217 Fix logic error in AttributedString.Runs.subscript

(Discovered during code review.)

* rdar://108152217 Clean up CharacterView/UnicodeScalarView mutations & update failing test

* rdar://108152217 Apply review notes
2023-06-26 13:51:15 -07:00

104 lines
3.3 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2020-2023 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
@_implementationOnly @_spi(Unstable) import CollectionsInternal
#else
package import _RopeModule
#endif
@available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
extension AttributedString.Runs {
@dynamicMemberLookup
public struct Run: Sendable {
internal typealias _AttributeStorage = AttributedString._AttributeStorage
internal let _attributes: _AttributeStorage
internal let _range: Range<BigString.Index>
// FIXME: Remove this and update description to only print attribute values
internal let _guts: AttributedString.Guts
internal init(
_attributes attributes: _AttributeStorage,
_ range: Range<BigString.Index>,
_ guts: AttributedString.Guts
) {
self._attributes = attributes
self._range = range
self._guts = guts
}
}
}
@available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
extension AttributedString.Runs.Run: Equatable {
public static func == (lhs: Self, rhs: Self) -> Bool {
lhs._range._utf8OffsetRange.count == rhs._range._utf8OffsetRange.count
&& lhs._attributes == rhs._attributes
}
}
@available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
extension AttributedString.Runs.Run: CustomStringConvertible {
public var description: String {
AttributedSubstring(_guts, in: _range).description
}
}
@available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
extension AttributedString.Runs.Run {
public var range: Range<AttributedString.Index> {
let lower = AttributedString.Index(_range.lowerBound)
let upper = AttributedString.Index(_range.upperBound)
return Range(uncheckedBounds: (lower, upper))
}
internal var _utf8Count: Int {
_range._utf8OffsetRange.count
}
internal func clamped(to range: Range<BigString.Index>) -> Self {
Self(_attributes: self._attributes, _range.clamped(to: range), _guts)
}
public var attributes: AttributeContainer {
AttributeContainer(self._attributes)
}
}
@available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
extension AttributedString.Runs.Run {
@preconcurrency
public subscript<K: AttributedStringKey>(
dynamicMember keyPath: KeyPath<AttributeDynamicLookup, K>
) -> K.Value?
where K.Value: Sendable {
get { self[K.self] }
}
@preconcurrency
public subscript<K: AttributedStringKey>(_: K.Type) -> K.Value? where K.Value: Sendable {
get { _attributes[K.self] }
}
public subscript<S: AttributeScope>(
dynamicMember keyPath: KeyPath<AttributeScopes, S.Type>
) -> ScopedAttributeContainer<S> {
get { ScopedAttributeContainer(_attributes) }
}
internal subscript<S: AttributeScope>(_ scope: S.Type) -> ScopedAttributeContainer<S> {
get { ScopedAttributeContainer(_attributes) }
}
}