String.Indexの表示説明を改善する

String.Index に CustomDebugStringConvertible への適合を追加し、debugDescription としてデバッグに役立つ形式の文字列を返すようにします。print や String(reflecting:) を通じて、そのインデックスが指している位置・想定しているエンコーディング・必要ならトランスコード後のオフセットまでを読み取れるようになります。

let string = "👋🏼 Helló"

print(string.startIndex) // ⟹ 0[any]
print(string.endIndex) // ⟹ 15[utf8]
print(string.utf16.index(after: string.startIndex)) // ⟹ 0[utf8]+1
print(string.firstRange(of: "ell")!) // ⟹ 10[utf8]..<13[utf8]

表示の読み方は次のとおりです。

• 15[utf8] は「UTF-8 エンコードされた String のオフセット 15 のコードユニットを指す」ことを表します。
• startIndex のようにオフセットが 0 の位置はどのエンコーディングでも同じ位置になるため、0[any] と表示されます。
• Swift 6.0 以降、一部プラットフォームでは String が UTF-16 のままテキストを保持している場合があり、そのようなインデックスは [utf16] と表示されます。
• 0[utf8]+1 の +1 は、トランスコードした Unicode スカラ内でのオフセットです。上の例では先頭の絵文字 U+1F44B（UTF-8 では F0 9F 91 8B、UTF-16 では D83D DC4B）を UTF-16 として見たときの後続サロゲート DC4B を指しており、この位置はストレージ上には存在せず、アクセスのたびに計算されます。

なお、debugDescription が返す文字列の具体的な書式や情報量は規定されていません。これは CustomDebugStringConvertible に適合する型でよく採られる方針で、String の内部実装が進化すればそれに合わせて表示も変わり得ます。書式をプログラムから解釈したり、debugDescription の内容に依存したコードを書いたりすることは想定されていません（ここで示した例も、現行実装を説明するための参考例にすぎません）。この書式は LLDB では Swift 5.8 から既にデータフォーマッタとして採用されており、そこで有用性が確かめられたものです。

バックデプロイと ABI について

この適合自体は Swift 6.1 の標準ライブラリで追加されたもので、ABI 安定プラットフォーム上ではバックデプロイできません。ただし String.Index.debugDescription プロパティ自体はバックデプロイ対応（@backDeployed(before: SwiftStdlib 6.1)）になっており、古い OS 上でも明示的に debugDescription を呼び出せば新しい表示を得られます。

let str = "🐕 Doggo"
print(str.firstRange(of: "Dog")!)
// 旧 stdlib: Index(_rawBits: 327943)..<Index(_rawBits: 524551)
// 新 stdlib: 5[utf8]..<8[utf8]

print(str.endIndex.debugDescription)
// どの環境でも: 11[utf8]

もっとも、通常のコードで .debugDescription を明示的に呼び分けるスタイルは推奨されていません。基本的には「新しい stdlib では print の結果が読みやすくなる」という位置づけで理解しておけば十分です。