TextKitおよびテキストビューの最新情報

TextKitおよびテキストビューの最新情報

UIフレームワークのTextKitやテキストビューの最新情報をご覧ください。レイアウトの改良やAPIの強化について解説し、複数のOSバージョン間の互換性を維持する方法や、TextKit 2でAppを最新化する方法を紹介します。このセッションを最大限に活用するには、WWDC21の「TextKit 2について」を最初にご覧ください。

リソース
- - HDビデオ
  - SDビデオ
関連ビデオ

WWDC22
- UIKitの最新情報
WWDC21
- TextKit 2について
ダウンロード

TextKitとテキストビューの新機能へようこそ TextKitエンジニアの Donna Tomです
iOS 15とmacOS Montereyでは強力なテキストエンジンである TextKit 2を導入し大きく向上したのは正確性と安全性です
TextKit 2のビューポートベースレイアウトアーキテクチャはコンテンツの多い文書に対して高性能のレイアウトを提供します
TextKit 2はグリフ操作から複雑さを取り除くことにより海外ユーザーにより良いテキスト体験を提供します OpenTypeなどの最新フォントテクノロジーも完全にサポートしています
テキストレイアウトを制御するためにオブジェクト操作でレイアウトを簡単にカスタマイズでき少ないコードでクールに作成できます
今後TextKit 2のエンジンは Appleの全プラットフォームでの基盤を形成します
将来のパフォーマンスの強化更新また改善はすべて TextKit 2エンジンに割り当てられますアップデートすることであなたのAppはこれらの改善のメリットを享受できます TextKit 2の詳細については「TextKit 2について」の動画をご覧くださいそちらの動画では独自の― レイアウト構築方法と基本事項について説明していますこの動画では最新情報をカバーしテキストビュー（複数）を最大限に活用する方法を説明しますそう　テキストビューが複数なのは iOS 16とmacOS Venturaの UIKitとAppKitの全テキスト制御において TextKit 2が使用されているからですシステム全体でTextKit 2が活躍しているのです AppをすぐにでもTextKit 2へ移行することが重要なので移行のためのツールも追加されました多くのAppではコードを書くことなく移行が可能ですテキストビューに特別な変更のないAppにもこれは該当しますこれについては後でもう少し説明します
まずはTextKit 2の新機能について先ほど触れたツールについても説明します
続いてテキストビューの TextKit 1との― 互換モードについて詳しく説明します
最後にTextKit 2への移行準備の際使用できる戦略についても説明します
まずTextKit 2の新機能についてです
TextKit 2は iOS 15で初めてUIKitに登場し UITextFieldがアップグレードされました iOS16では UIKitのTextKit 2への移行が完了し UITextViewを含むデフォルトで全てのコントロールで適用されますほぼ自動的にTextKit 2にオプトインされるのでデベロッパ側での変更は不要ですテキストビューが適用されない状況は動画の互換性部分で説明します
AppKitについても同様です macOS Big SurでAppKitに登場したTextKit 2は macOS Montereyでは NSTextFieldをデフォルトにオプトインすることで利用できました
macOS Venturaでは TextKit 2がデフォルトになりましたほとんどのNSTextViewは TextKit 2に自動的にオプトインしデベロッパ側での変更は不要です
TextEditもmacOS Venturaで TextKit 2をフルに活用します macOS Big Sur以降プレーンテキストでは TextKit 2を使用します macOS Venturaではリッチテキストモードでも使用されます
TextKit 2は新しいスタンダードのため UITextViewとNSTextViewに便利なコンストラクターが追加されましたこれらのコンストラクターを使用して初期化時のテキストエンジンを選択します
TextKit 2によるビューを作成するには新しいコンストラクターを使用してレイアウトパラメータに “true”を渡します互換性が必要な場合は “false”を渡します
またInterfaceBuilderによる新しいレイアウトもこれを使用してレイアウトシステムをインスタンスごとに制御できますシステムデフォルトは TextKit 2です
新旧どちらかを明示的に使用することもできます
TextKit 2はテキストコンテナもサポートします穴やギャップがあるコンテナの場合がありますこの場合テキストを画像やその他のコンテンツにラップできます
複雑なテキストコンテナを作成するにはNSTextContainerで exclusivePaths プロパティを使用してテキストを配置しない領域を定義します例については動画の関連リソースから TextKitAndTextViewサンプルコードを確認してください関連する例は「exclusion path」タブにあります
TextKit 2の改行エンジンを拡張して両端揃えの段落に対してより均等な改行が可能になりました微妙な変更ですが長い段落でより明らかになります
これは同じ領域に配置されたテキストですが
従来の改行による単語間の間隔に着目してみてください
改行がはるかに少ないことがお分かりいただけると思います読みやすくなったテキストは TextKit 2で無料で入手できます変更は必要ありません
最後に全プラットフォームで TextKit 2のリストをサポートしますテキストリストを使用すると表示のための箇条書きリストまたは番号リストをプログラムで作成できます TextKit 2はNSTextListでテキストリストを表示します NSTextListは以前は AppKitのみでした iOS 16ではUIKitでも利用可能です
NSTextListをNSmutable ParagraphStyleと使用してストレージ内の段落をリストとしてフォーマットしますテキストビューはストレージからこれらの属性を取得し段落の内容をリストとして再フォーマットします
NSTextList自体は新しいものではありませんリストにはネストされたアイテムを含められるのでツリー構造で表示するのが自然です TextKit 2では子要素と親要素にアクセスするためのプロパティを持つツリーとしての構造化をサポートしています
NSTextListElementという新しいサブクラス要素が追加されましたコンテンツマネージャが NSTextListを検知するとリスト内のアイテムを生成します
リストの作成方法とアイテムの追加方法は TextKitAndTextViewサンプルコードを参照してください関連する例はタブにあります
サンプルコードでは添付ファイル例もお見逃しなく TextKit 2でのプロバイダーAPIの使用方法が紹介されています
これらのAPIでUIまたはNSViewをテキスト添付として使用しイベントを添付ビューで直接処理できますこれによりイベント処理が簡単になりました TextKit 2ならではですこれでTextKit 2の新機能は以上です次に互換モードの詳細についてです TextKit 2は大きく進化しているため採用には時間がかかる可能性もあるでしょう旧版に特化したAppの場合は特にそうかもしれません移行が完了までAppが正常に機能することがが望まれますので特別なTextKit 1互換モードを UITextViewと NSTextViewに追加しました NSLayoutManagerの APIを明示的に呼び出すとテキストビューが置換され TextKit 1を使用するよう再構成しますこれはテーブルなどの TextKit 2で未サポート属性の検出や印刷時にも発生しかねません
UITextViewのTextKit 1で予期しないランタイムフォールバック発生時にはログでスイッチに関する警告をご確認くださいシンボルアンダースコアにブレークポイントを設定しスタックトレースやデバッグ情報をキャプチャします
NSTextViewに関してはwillSwitch またはdidSwitchToNSLayoutManagerに登録することで予期しないフォールバック情報や通知などを受け取るすることが可能です
TextKit 1に戻る必要がある場合は初期化時にオプトアウトしたうえで初期化されたテキストビューを推奨しますこれには独自のテキストコンテナと TextKit 1レイアウトマネージャを使用します
別のオプションとしては新しいコンストラクターによる TextKit 1ビューの初期化でパラメータとしてfalseを渡すことですこれによりTextKit 1が使用されるようになります
３番目のオプションは InterfaceBuilderを使ってレイアウトオプションを TextKit 1に設定することです
注意すべきことが一点あります初期化中や直後にテキストコンテナの― レイアウトマネージャを置換するとテキストビューは旧版にフォールバックします初期化中にTextKit 2 オブジェクトを作成して後で破棄するのは非効率的ですタイミングによっては誤動作もあります入力中に発生した場合テキストビューの中断された入力を再開するにはテキストビューの選択が再度必要です初期化時にオプトアウトしてこれを回避しましょう互換モードに関する情報を紹介しました続いてはAppを最新にアップデートし回避する方法としての TextKit 2の採用についてお話します覚えておいてほしい重要な点が１つあります
テキストビューごとのレイアウトマネジャーは１つのみ採用できます NSTextLayoutManagerと NSLayoutManagerの両方を同時に含めることはできません
TextKit 1に切り替わると自動的には戻せる方法はありませんレイアウトシステムの切り替えはコストがかかるうえ切り替え時にあった UI状態はすべて破棄されてしまいます最適なパフォーマンスと使いやすさのためにテキストビューがTextKit 2に戻ることはありません一方向の操作です
これは互換モードの回避が非常に重要だということですまた互換モードに入る理由もいくつかありますテキストビューが互換モードに入る最大の理由はlayoutManager プロパティへのアクセスです他の理由は一般的ではありません
つまりテキストビューのレイアウトプロパティにアクセスしないようにすることが重要ですテキストコンテナからレイアウトマネージャへのアクセスは避けてくださいこれらプロパティの使用に際しコードを監査し削除するか同等の TextKit 2に置換します
また TextKit 2未搭載の旧版OSにAppをデプロイしてもlayoutManagerコードを削除できない可能性があります
その場合まずNSTextLayout Managerを確認します
TextKit 2コードをif句に格納し旧版コードをelse句に格納し layoutManager アクセスも含めますこのようにTextKit 2が使用できない場合のみ実行され layoutManagerクエリによる TextKit 1へのフォールバックを防ぎます
これらすべてを実行してもまだTextKit 1への予期しないフォールバックが発生する場合フィードバックアシスタントで報告してくださいフォールバック時にスタックトレースのキャプチャに含めるのが UIKitでは互換モード AppKitではwillSwitch になります
ではTextKit 1に関連するコードの更新の詳細について説明します NSLayoutManagerクエリのコードを監査したら NSLayoutManagerに相当するTextKit 2を精査する必要があります
一部のレイアウトマネジャー APIはTextKitの新旧間で類似した名称のため置換は簡単ですいくつかの例をあげます旧版ではNSLayoutManagerで usedRect(for:textContainer)を呼び出してコンテナ内のテキストの境界矩形を取得します TextKit 2ではNSTextLayoutManagerの usageBoundsForTextContainer プロパティからこれを取得します
TextKit 1ではレンダリング属性の場合「temporary attributes」という名称で処理しました TextKit 2では「rendering attributes」と呼びます
TextKit 1のAPIには TextKit 2に直接該当するものがないものもありますその理由を理解するにはグリフマッピング用のインド文字カンナダ語などの例がありますこれらのスクリプトではグリフを分割並べ替えや再結合に削除なども可能です
NSLayoutManagerのグリフベースのAPIで連続した範囲の文字を関連付けられると仮定しますがグリフはすべてのスクリプトに該当しませんこれらAPIを使用するとレンダリングが崩れるのがカンナダ文字などでは起こり得ますそのためTextKit 2にはグリフAPIがありません単一APIをTextKit 1 グリフAPIに置換できないのでこれらAPIの置換には別アプローチが必要です
グリフベースのコードの更新方法は次のとおりですまずグリフAPIを特定することから始めます次にこれらAPIの使用法を確認しその目的をハイレベルで定義しますグリフベースのコードの詳細の多くはハイレベルのタスクには無関係です
ハイレベルのタスクを定義したら次にレイアウトや行にテキスト選択など TextKit 2で使用できる構造を調べますこれでタスク管理は万全ですたとえばこのTextKit 1コードここに２つのグリフAPIがあります numberOfGlyphsと lineFragmentRectですこのTextKit 1コードは全グリフを反復処理し線の断片を処理しますハイレベルのタスクは折り返されたテキストの行数をカウントすることですこのコードは行フラグメントで機能するので対応するTextKit 2構造は NSTextLineFragmentと NSTextLayoutFragmentです TextKit 2用に書き直されたコードがこちらですグリフを反復処理する代わりにドキュメント内のレイアウトフラグメントを列挙し各フラグメント内のすべての行フラグメントをカウントするクロージャを提供します
TextKit 2用にコードを更新するときはこの例を念頭に置いてください次にNSRangeに基づくコードの更新についてです
TextKit 1ではNSRangeを使ってコンテンツをインデックス化します NSRangeは文字列への線形インデックスです「HelloTextKit 2！」というテキストの場合感嘆符を表すNSRangeは６番目の文字から始まり長さが10文字なので位置が６で長さ10として定義されますこの線形モデルは理解しやすく文字列へのインデックス作成に最適です
ただし線形モデルは文字列よりも多くの構造を持つコンテンツでは機能しませんこちらが例です HTMLドキュメントはツリー構造として表され各タグはツリー内のノードです Hello TextKit 2！の場合テキストはHTML ドキュメントの一部であり NSRangeがネストされた spanタグ内にあることを― 通知する方法はありません線形モデルはその情報を格納する表現がないためネストされた構造にインデックス付けるために使用できませんこれが今回テキストコンテンツ範囲を表す新タイプを追加した理由です NSTextLocationはテキストコンテンツ内の単一の位置を表すオブジェクトです NSTextRangeは開始位置と終了位置で構成されます終了位置は範囲から除外されますこれらの新しいタイプは HTMLのネスト構造を表し位置をDOMノードと文字オフセットとして定義します
NSTextLocationはプロトコルであるため任意のカスタムオブジェクトは NSTextLocationプロトコルメソッドを実装している限り定義可能ですバッキングストア操作の重要なインフラでモデルで構造化データをサポートします
ただしテキストビューはこの構造を持たない NSAttributedStringストアに基づいて構築されているため Appを壊すことなく変更を加えることはできませんしたがってselectedRangeや scrollRangeToVisibleなどのテキストビューAPIを使用する場合は引き続きNSRangeを使用します TextKit 2レイアウトやコンテンツマネジャーと通信するには NSRangeとNSTextRange 間で変換する必要があります
NSRangeをNSTextRangeに変換するには位置を属性付き文字列の整数インデックスとして定義します
NSTextRangeの開始位置としてNSRangeの位置を使用し
NSRangeの位置と長さを NSTextRangeの終了位置として使用します概念的にはこれがNSRangeから NSTextRangeにマップする方法です
実際にはコードが少し異なって見えるのは NSTextLocationsはオブジェクトである必要があるためです
位置の計算はコンテンツマネジャー経由で行います
開始位置についてはコンテンツマネジャーを参照しドキュメントの先頭位置について確認し次にNSRangeの位置でオフセットします次に開始位置をNSRangeの長さでオフセットして終了位置を取得します
反対方向に進むにはコンテンツマネジャーを使用し２つの異なるオフセットを取得します
NSRangeの位置はドキュメントの先頭と NSTextRangeの位置からのオフセットですまたNSRangeの長さは NSTextRangeの開始位置と終了位置のオフセットです
UITextViewsとUITextFields はInputプロトコルに準拠し UITextPositionと範囲を使用しますほとんどの場合変換の必要はなく UITextRangeを NSTextRangeに直接― UITextViewまたは UITextFieldを使用できますただしその場合は２つのタイプの中間として整数オフセットを使用してください
UITextInputでカスタムビューを使用する場合は UITextPositionや UITextRangeサブクラスをビューで使用して直接制御できます UITextPosition サブクラスを作成し NSTextLocationに準拠し必要なメソッドを実装しサブクラスを使用して NSTextRangesを直接作成します
ビューのコンテンツが類似している場合でも異なるビュー間でUITextPosition オブジェクトの再利用は不可です UITextPosition作成に使用されたビューに対してのみ有効です
これでコードを最新化するための戦略を利用できるようになりましたこれら戦略を適用すると AppはTextKit 2のメリットを享受できるようになります
TextKitとテキストビューの新機能でした多くの改善点を取り上げ古いバージョンとの互換性を維持しながらAppを更新するための戦略をいくつか共有しました改善点を最大活用するには今すぐTextKit 2のテキストビューをチェックして意図せずに旧版にフォールバックしていないことを確認します
モダナイゼーション戦略を採用してあなたはどんなAppを作成するのでしょうかご覧いただきありがとうございます

13:21 - Check for NSTextLayoutManager first

if let textLayoutManager = textView.textLayoutManager {
    // TextKit 2 code goes here
}
else {
    let layoutManager = textView.layoutManager    
    // TextKit 1 code goes here
}

17:41 - Counting number of lines of wrapped text in a text view with TextKit 2

// Example: Updating glyph-based code 

var numberOfLines = 0
let textLayoutManager = textView.textLayoutManager

textLayoutManager.enumerateTextLayoutFragments(from:
                                               textLayoutManager.documentRange.location,
                                               options: [.ensuresLayout]) { layoutFragment in
        numberOfLines += layoutFragment.textLineFragments.count
}

21:10 - Convert NSRange to NSTextRange

let textContentManager = textLayoutManager.textContentManager

let startLocation = textContentManager.location(textContentManager.documentRange.location, 
                                                offsetBy: nsRange.location)!

let endLocation = textContentManager.location(startLocation, 
                                              offsetBy: nsRange.length)

let nsTextRange = NSTextRange(location: startLocation, end: endLocation)

21:40 - Convert NSTextRange to NSRange

let textContentManager = textLayoutManager.textContentManager

let location = textContentManager.offset(from: textContentManager.documentRange.location,
                                         to: nsTextRange!.location)

let length = textContentManager.offset(from: nsTextRange!.location,
                                       to: nsTextRange!.endLocation)

let nsRange = NSRange(location: location, length: length)

22:02 - Convert UITextRange to NSTextRange

let offset = textView.offset(from: textview.beginningOfDocument, to: uiTextRange.start)

let startLocation = textContentManager.location(textContentManager.documentRange.location, 
                                                offsetBy: offset)!

let nsTextRange = NSTextRange(location: startLocation)

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース

関連ビデオ

WWDC22

WWDC21