前回までは、メソッドを操作するランタイムAPIを紹介してきたので、次は当然インスタンス変数の出番だ。今回は、インスタンス変数を取り扱うための、構造体を紹介しよう。

インスタンス変数の定義の取得

Objective-Cのクラス定義には、既に述べたようにメソッドの定義が含まれていて、さらにインスタンス変数の定義も含まれている。objc_class構造体に含まれている、instance_sizeとivarsが、それだ。

objc-class.h

instance_sizeは、このクラスが持つインスタンス変数の合計サイズになる。言い換えれば、このクラスのインスタンスを作成したときに、確保されるメモリの大きさ、という訳だ。ivarsの方が、インスタンス変数の定義になる。この変数は、objc_ivar_list構造体へのポインタになる。この構造体の定義は、次の通りだ。

objc-class.h

名前の通り、objc_ivarという構造体の配列を管理するためのものだ。ivar_countは配列の数、objc_ivarが配列になる。さて、ここまでくればもう感付いている方もいると思うが、このobjc_ivarがインスタンス変数の定義となる構造体である。その定義は、次の通りだ。

objc-class.h

この構造体には、3つのフィールドがある。1つ目のivar_nameは、インスタンス変数の名前になる。2つ目のivar_typeは、変数の型だ。この型は、メソッドの型と同じ形にエンコーディングされている。型のエンコーディングについては、本連載の第20回を参考にしてほしい。そして、3つ目のivar_offsetは、この変数がメモリ内部でどこに配置されるかを表している。インスタンス変数のために確保したメモリの、先頭からのオフセットになる。

また、この構造体のポインタを表すための型も定義されている。Ivarという名前の型だ。

objc-class.h

実際のコードでは、こちらを使うことも多いだろう。

インスタンス変数の名前の表示

では、このIvarを利用して、クラス定義からインスタンス変数の定義を抜き出すコードを紹介しよう。次のコードでは、すべてのインスタンス変数の名前を表示している。

objc-class.h

まず始めに、Class型の変数に、ivarsが存在しているかどうかを確認している。インスタンス変数定義が無い場合、このフィールドはNULLになっているので、注意が必要だ。

次に、objc_ivar_list構造体の、ivar_countの値を表示している。これが、インスタンス変数の定義の数になる。そして、forループを回して、Ivarを取り出している。Ivarからは、ivar_nameにアクセスして、インスタンス変数の名前を調べることができる、という訳だ。

この方法で調査できるのは、指定したクラスに含まれるインスタンス変数だけだ、ということにも注意しておこう。つまり、親クラスのインスタンス変数の名前は表示されない。それらを表示するには、superclassの定義を調査することが必要になる。

次回は、このIvarを使って、インスタンス変数の値にアクセスする方法を説明しよう。