lifeLOG + REPOsitory: Cocoa アプリの構造 #1: Nib の周辺

Cocoa アプリでは、アプリが利用するさまざまなリソースを Nib ファイルに保持している。この中には、アイコン等の画像データに加えて、メニューやウィンドウといったユーザインターフェースの記述もふくまれている。アプリによっては、複数の Nib ファイルを持つものもあり、当然、どの Nib をどういうタイミングでロードするのかを制御する仕組みが存在する。この仕組みが気になり少し調べてみたので、わかった範囲で記録しておく。

アプリと Nib の関係
MyDocument と Nib の関係

アプリと Nib の関係

Cocoa アプリのスタートポイントは NSApplicationMain 関数で、その処理は主に次の 3 つ。

NSApplication のオブジェクトを作ること (グローバル変数 NSApp にセットされる)
アプリの主要 Nib ファイルをロードすること
NSApp に run メッセージを送ること

今回、ふと気になって調べたのがこの 2 番目。Nib ファイルのロードについて。具体的には、どの Nib ファイルが、いつロードされるのか、また、そのトリガーは何なのか、など。ちなみに Xcode/Interface Builder 3.0 以降は、デフォルトでバイナリ形式の Nib に代わって XML 形式の「Xib ファイル」が使われる。SCM ツール等との相性の良いテキスト形式のフォーマットを作ったとのこと。ビルドの際に Nib へと変換される。([4]を参照)

まずは、アプリに対して 1 つ存在する「主要 Nib ファイル」というものについて。これはどこで指定しているんだろうか? Xcode で Cocoa アプリ用のプロジェクトテンプレートを指定すると、MainMenu.xib が作られ、これが主要 Nib になる。まさか、ファイル名がハードコードされているはずもないから、どこかに名前の指定があるはず。

[2] の "Changing the Nib Files from the Xcode Defaults" の記述でそれが判明した。Xcode からプロジェクトのターゲットからアプリケーションを選び、「ファイル」>「情報を見る」。「情報」パネルの「プロパティ」タブを開くと、中段に「主要クラス」と「主要Nibファイル」の設定がある (右図)。

ちなみに、これら「プロパティ」の設定は、Info.plist としてアプリにくっついて行く。

MyDocument と Nib の関係

Cocoa アプリのプロジェクトを作る際に "document-based application" を指定すると、Document-Based アプリ([3]を参照)を作ることができる。このとき、Xcode が自動生成する Nib ファイルは MainMenu.xib と MyDocument.xib の 2 つ。前者は上述のようにアプリの「主要 Nib ファイル」だ。後者はファイルを作成、編集する際に表示するユーザインターフェースを記述するためのもの。では、MyDocument.xib はいつ(何をきっかけとして)、誰が(どのオブジェクトが) ロードするのか? その答えも [3] に書かれていた。以下は、プロジェクトテンプレートが想定する、もっともシンプルな場合の動きだ。

Document-Based アプリでは、NSDocumentController というオブジェクトが存在し、ドキュメントの作成やオープンを担当している。メインメニューからファイルの新規作成やオープンが選択されると、NSDocumentController に指示が届く。で、このオブジェクトは生成する(開く)ドキュメントのタイプに応じて、適切なクラス(NSDocumentのサブクラス; デフォルトでは MyDocument)のオブジェクトを生成する。このオブジェクトとドキュメント編集のための Nib ファイル(MyDocument.xib) との結び付きは、MyDocument の windowNibName メソッドが返す文字列によって作られる。デフォルトではこれが "MyDocument" となっている。

さて、では NSDocumentController はドキュメントのタイプと MyDocument クラスをどこで結び付けているのだろうか? それも、Info.plist だ。その中で、ドキュメントタイプごとに拡張子やアイコン等と一緒にクラスも指定する。