AttributedString の不連続な範囲に対する操作

AttributedString に RangeSet<AttributedString.Index> を受け取るサブスクリプトと、不連続な範囲を表す新しい型 DiscontiguousAttributedSubstring が追加されます。FoundationPreview 6.2 以降で利用できます。

var text = AttributedString("Hello, world!")

// "l" の位置すべてを表す RangeSet を取得（既存 API）
let indicesOfL: RangeSet<AttributedString.Index> = text.characters.indices(of: "l")

// 不連続な範囲に対してまとめて属性を設定
text[indicesOfL].foregroundColor = .blue

print(text[indicesOfL]) // "lll { SwiftUI.ForegroundColor = ... }"

// 不連続な範囲の attribute run を走査
for (range, color) in text[indicesOfL].runs[\.foregroundColor] {
    // ...
}

text.characters.indices(of:) のように、RangeSet を返す API はビューを通して既に使えていました。今回の変更で、その RangeSet を AttributedString 本体や AttributedStringProtocol のサブスクリプトに直接渡せるようになり、不連続な範囲に対する属性の読み取り・更新を 1 つの式で書けるようになります。

DiscontiguousAttributedSubstring

text[someRangeSet] の戻り値となるのが、新しく追加される DiscontiguousAttributedSubstring です。連続した範囲に対する AttributedSubstring の不連続版にあたる位置づけで、AttributedStringAttributeMutation に適合し、属性の取得・設定・マージ・置換と、属性キーパスによるサブスクリプト（.foregroundColor のような書き方）を提供します。

@available(FoundationPreview 6.2, *)
public struct DiscontiguousAttributedSubstring: AttributedStringAttributeMutation,
    CustomStringConvertible, Sendable, Hashable {
    public var base: AttributedString { get }

    // 範囲によるさらなるスライス
    public subscript(bounds: Range<AttributedString.Index>) -> DiscontiguousAttributedSubstring { get }
    public subscript(bounds: RangeSet<AttributedString.Index>) -> DiscontiguousAttributedSubstring { get }

    // 各種ビュー
    public var characters: DiscontiguousSlice<AttributedString.CharacterView> { get }
    public var unicodeScalars: DiscontiguousSlice<AttributedString.UnicodeScalarView> { get }
    public var utf8: DiscontiguousSlice<AttributedString.UTF8View> { get }
    public var utf16: DiscontiguousSlice<AttributedString.UTF16View> { get }
    public var runs: AttributedString.Runs { get }
}

characters / unicodeScalars / utf8 / utf16 は標準ライブラリの DiscontiguousSlice として返るため、不連続な部分のテキスト本体やコードユニットを順に走査できます。runs は通常の AttributedString.Runs ですが、対象範囲に応じた attribute run のみを返します。

DiscontiguousAttributedSubstring は AttributedStringProtocol には適合していません。これは、AttributedStringProtocol のサブスクリプトが連続した AttributedSubstring を返すよう要求しているのに対し、不連続な部分文字列をさらに範囲でスライスした結果は再び不連続になり得るためです。代わりに、AttributedStringAttributeMutation 経由で属性まわりの主要な操作だけが利用できる設計になっています。

AttributedString 本体への追加 API

AttributedString には RangeSet を受け取るサブスクリプトと、不連続な範囲をまとめて削除する removeSubranges(_:) が追加されます。DiscontiguousAttributedSubstring から AttributedString を作るイニシャライザも用意されます。

@available(FoundationPreview 6.2, *)
extension AttributedString {
    public init(_ substring: DiscontiguousAttributedSubstring)

    public subscript(_ indices: RangeSet<AttributedString.Index>) -> DiscontiguousAttributedSubstring {
        get
        set
    }

    public mutating func removeSubranges(_ subranges: RangeSet<Index>)
}

@available(FoundationPreview 6.2, *)
extension AttributedStringProtocol {
    public subscript(_ indices: RangeSet<AttributedString.Index>) -> DiscontiguousAttributedSubstring { get }
}

AttributedStringProtocol 側の追加は読み取り専用で、AttributedSubstring などプロトコル経由でも不連続スライスを取り出せます。

サブスクリプトに set があるため、text[rangeSetA] = otherText[rangeSetB] のように不連続な部分文字列ごと差し替えることもできます。両者の不連続な範囲の数や長さが揃っていない場合の挙動は、replaceSubranges 相当（対応する範囲を 1 対 1 で置換していくセマンティクス）に揃えられています。

AttributedString.Runs.Index の Strideable 適合の deprecation

attribute run のインデックスである AttributedString.Runs.Index はこれまで Strideable に適合しており、runs.index + 1 のような数値オフセットでの計算が可能でした。しかし、不連続なスライスでは「あるインデックスから 1 つ進んだインデックス」を計算する際に、同じ run が複数の不連続な区間に分かれて登場する可能性があり、コレクションを介さずに正しく求めることができません。

そこで、Strideable への適合は今後 deprecate されます。インデックスを進めたい場合は、AttributedString.Runs が提供する index(_:offsetBy:) などのコレクション API を使ってください。Strideable 適合自体は残るため、既存コードがすぐに壊れることはなく、コンパイラからの警告に従って移行する形になります。