Associative Storage: カテゴリに疑似インスタンス変数を追加

Tags: Cocoa, DesignPatterns, Objective-C

イントロダクション

Objective-Cのカテゴリはサブクラスを作ることなくメソッドの拡張(またはメソッドごとの分類)が行える点で強力だ。しかしメソッドの定義はできてもインスタンス変数の追加ができない。そこでCocoaのKey Value Coding (KVC)の機能を用いてカテゴリに擬似的にインスタンス変数を生成させる。これにより元クラスを手直しすることなくインスタンス変数を追加することができる。なおこの手法は、よりフレキシブルという理由でNSMapTableを用いるのが一般的なようだが、ここではNSMutableDictionaryを代用した。理由は使い慣れているからだ。NSMapTableを用いた方法はBuck and Yacktman - Cocoa Design Patternsが詳しい。

具体例

簡単な例としてボタンを押すとアラートを表示するアプリケーションを考える。ボタンプッシュ後の動作はAppControllerクラスで以下のように定義されているとする。

//AppController.m
 
@implementation AppController
 
-(IBAction)buttonPressed:(id)sender{
	NSRunAlertPanel(@"Alert", @"This is an alert.", @"OK", nil, nil);
}
 
@end

ここで「一度アラート表示された場合は再度アラートを表示させない」仕様に変更するとしよう。AppControllerにBOOL値を格納するインスタンス変数を追加して制御するのが手っ取り早いが、ここではAppControllerのカテゴリ(ShowAtOnce)を新規に定義して制御することにする。カテゴリ作成の大まかな手順は以下のようになる。

1. 疑似インスタンス変数格納用にNSMutableDictionary変数をカテゴリに定義
2. 疑似インスタンス変数としたいオブジェクトを上記NSMutableDictionary変数に格納。その際のキーストリングはAppControllerインスタンスに固有のものを用いる
3. 格納したオブジェクトのAccesors (Setters/Getters)をカテゴリに定義
4. インスタンスの解放時にNSMutableDictionaryからオブジェクトを消去するメソッドをカテゴリに定義

以下順にみていこう。

1. 疑似インスタンス変数格納用変数の定義

疑似インスタンス変数にしても情報を格納する場所は必要になる。そこで疑似インスタンス変数を格納する場所としてNSMutableDictionaryオブジェクトをカテゴリ(ShowAtOnce)に定義する。さらにこのオブジェクトのAccesorsをクラスメソッドとして定義する。つまりこの格納用のNSMutableDictionaryオブジェクトはAppControllerインスタンスすべてで使い回されることになる。

//AppController-ShowAtOnce.m
 
@implementation AppController (ShowAtOnce)
 
static NSMutableDictionary *_simulatedIVars = nil;
 
+(NSMutableDictionary *)_simulatedIVars{
	if (_simulatedIVars == nil){
		_simulatedIVars = [[NSMutableDictionary alloc] init];
	}
	return _simulatedIVars;
}
 
@end

2. インスタンス固有のキーストリング

上記例のアプリケーションの仕様を実現するためには、一度アラートが表示されたかどうかを調べるBOOL値を(NSMutableDictionary *)_simulatedIVarsに格納できればよさそうだ。しかし今は疑似インスタンス変数を作りたいのでAppControllerインスタンスごとに異なる値を格納できるようにする必要がある。そこでまず「AppControllerインスタンスに固有なNSStringオブジェクト」を生成するメソッドを定義する。このメソッドは-[AppController self]のストリング表現を返す。

//AppController-ShowAtOnce.m
 
-(NSString *)_instanceID{
	return [NSString stringWithFormat:@"%@", self];
}

さらに「疑似インスタンス変数名に相当するNSStringオブジェクト」を用意する。これはクラス全体で使い回しができるようにすればよい。ここではAlertHasEverBeenShownKeyStringという名前で定義しておこう。

//AppController-ShowAtOnce.m
 
static NSString * const AlertHasEverBeenShownKeyString = @"alertHasEverBeenShown";

あとは「AppControllerインスタンスに固有なNSStringオブジェクト」と「疑似インスタンス変数名に相当するNSStringオブジェクト」を適当に繋げて「あるAppControllerインスタンスの疑似インスタンス変数に固有なNSStringオブジェクト」を作成するメソッドを定義する。このメソッドの返り値が(NSMutableDictionary *)_simulatedIVarsへの格納用キーストリングとして利用されるわけだ。

//AppController-ShowAtOnce.m
 
-(NSString *)_objectKeyForKeyString:(NSString *)aKeyString{
	return [NSString stringWithFormat:@"%@:%@", 
		[self _instanceID], aKeyString];
}

現在までのAppController (ShowAtOnce)の中身をまとめると以下のようになっているはずだ。

//AppController-ShowAtOnce.m
 
static NSString * const AlertHasEverBeenShownKeyString = @"alertHasEverBeenShown";
 
@implementation AppController (ShowAtOnce)
 
static NSMutableDictionary *_simulatedIVars = nil;
 
+(NSMutableDictionary *)_simulatedIVars{
	if (_simulatedIVars == nil){
		_simulatedIVars = [[NSMutableDictionary alloc] init];
	}
	return _simulatedIVars;
}
 
#pragma mark -
#pragma mark Utilities
 
-(NSString *)_instanceID{
	return [NSString stringWithFormat:@"%@", self];
}
 
-(NSString *)_objectKeyForKeyString:(NSString *)aKeyString{
	return [NSString stringWithFormat:@"%@:%@", 
		[self _instanceID], aKeyString];
}
 
@end

3. 疑似インスタンス変数のAccesors

上記メソッド群を利用してカテゴリ(ShowAtOnce)に定義する。Settersは-[AppController _setAlertHasEverBeenShown:]、Gettersは-[AppController _alertHasEverBeenShown]としよう。ここはstraightforwardだと思う。

//AppController-ShowAtOnce.m
 
-(BOOL)_alertHasEverBeenShown{
	NSString *aKey = 
		[self _objectKeyForKeyString:AlertHasEverBeenShownKeyString];
	id object = [[[self class] _simulatedIVars] objectForKey:aKey];
	if (object == nil){
		return NO;
	}
 
	return [object boolValue];
}
 
-(void)_setAlertHasEverBeenShown:(BOOL)yn{
	NSString *aKey = 
		[self _objectKeyForKeyString:AlertHasEverBeenShownKeyString];
	[[[self class] _simulatedIVars] 
		setObject:[NSNumber numberWithBool:yn] forKey:aKey];
}

あとはAppController内でこのメソッドを使ってやればよい。具体的には以下のようになるだろう。

//AppController.m
 
#import "AppController-ShowAtOnce.h"
 
@implementation AppController
 
-(IBAction)buttonPressed:(id)sender{
	if (![self _alertHasEverBeenShown]){
		NSRunAlertPanel(@"Alert", @"This is an alert.", @"OK", nil, nil);
		[self _setAlertHasEverBeenShown:YES];
	}
}
 
@end

4. 疑似インスタンス変数を解放

AppControllerインスタンスごとに(NSMutableDictionary *)_simulatedIVarsに登録されるのだからAppControllerインスタンスが不要になったら疑似インスタンス変数も解放する必要がある。そのために以下のようなメソッドをAppController(ShowAtOnce)に定義しておく。このメソッドは呼ばれれば不要になった疑似インスタンス変数を解放する。

//AppController-ShowAtOnce.m
 
-(void)_removeSimulatedIVars{
	NSString *aKey = 
		[self _objectKeyForKeyString:AlertHasEverBeenShownKeyString];
	id object = [[[self class] _simulatedIVars] objectForKey:aKey];
 
	if (object){
		[[[self class] _simulatedIVars] removeObjectForKey:aKey];
	}
}

さてこれまでAppControllerそのものを一切変更しないように実装すると言ってきたが実は嘘で、AppControllerそのものを手直しする必要がでてくる。というのも疑似インスタンス変数の解放を呼ぶメソッドをカテゴリに書くことは危険だからだ。例えば-[AppController dealloc]をカテゴリ(ShowAtOnce)に再定義することは可能だが、もし他に疑似インスタンス変数を持つ別カテゴリが同様の-[AppController dealloc]を実装した場合どちらの-[AppController dealloc]が呼び出されるかわからなくなるからだ(結果どちらかのカテゴリの疑似インスタンス変数は解放メソッドを呼ばれないがために生き残ってしまう)。したがって疑似インスタンス変数の解放メソッドを呼び出すのはAppControllerとするのがよいだろう。

//AppController.m
 
-(void)dealloc{
	[self _removeSimulatedIVars];
	[super dealloc];
}

全ソースコード

最終的なコードは以下のようになっている。

//AppController.h
 
#import <Cocoa/Cocoa.h>
 
@interface AppController : NSObject {
 
}
 
-(IBAction)buttonPressed:(id)sender;
@end

//AppController.m
 
#import "AppController.h"
#import "AppController-ShowAtOnce.h"
 
@implementation AppController
 
-(IBAction)buttonPressed:(id)sender{
	if (![self _alertHasEverBeenShown]){
		NSRunAlertPanel(@"Alert", @"This is an alert.", @"OK", nil, nil);
		[self _setAlertHasEverBeenShown:YES];
	}
}
 
-(void)dealloc{
	[self _removeSimulatedIVars];
	[super dealloc];
}
 
@end

//AppController-ShowAtOnce.h
 
#import <Cocoa/Cocoa.h>
#import "AppController.h"
 
@interface AppController (ShowAtOnce)
 
+(NSMutableDictionary *)_simulatedIVars;
-(void)_removeSimulatedIVars;
-(BOOL)_alertHasEverBeenShown;
-(void)_setAlertHasEverBeenShown:(BOOL)yn;
-(NSString *)_instanceID;
-(NSString *)_objectKeyForKeyString:(NSString *)aKeyString;
@end

//AppController-ShowAtOnce.m
 
#import "AppController-ShowAtOnce.h"
 
//Private
static NSString * const AlertHasEverBeenShownKeyString = @"alertHasEverBeenShown";
 
@implementation AppController (ShowAtOnce)
 
static NSMutableDictionary *_simulatedIVars = nil;
 
+(NSMutableDictionary *)_simulatedIVars{
	if (_simulatedIVars == nil){
		_simulatedIVars = [[NSMutableDictionary alloc] init];
	}
	return _simulatedIVars;
}
 
-(void)_removeSimulatedIVars{
	NSLog(@"%s", __FUNCTION__);
 
	NSString *aKey = 
		[self _objectKeyForKeyString:AlertHasEverBeenShownKeyString];
	id object = [[[self class] _simulatedIVars] objectForKey:aKey];
 
	if (object){
		[[[self class] _simulatedIVars] removeObjectForKey:aKey];
	}
}
 
#pragma mark -
#pragma mark Setters Getters
 
-(BOOL)_alertHasEverBeenShown{
	NSString *aKey = 
		[self _objectKeyForKeyString:AlertHasEverBeenShownKeyString];
	id object = [[[self class] _simulatedIVars] objectForKey:aKey];
	if (object == nil){
		return NO;
	}
 
	return [object boolValue];
}
 
-(void)_setAlertHasEverBeenShown:(BOOL)yn{
	NSString *aKey = 
		[self _objectKeyForKeyString:AlertHasEverBeenShownKeyString];
	[[[self class] _simulatedIVars] 
		setObject:[NSNumber numberWithBool:yn] forKey:aKey];
}
 
#pragma mark -
#pragma mark Utilities
 
-(NSString *)_instanceID{
	return [NSString stringWithFormat:@"%@", self];
}
 
-(NSString *)_objectKeyForKeyString:(NSString *)aKeyString{
	return [NSString stringWithFormat:@"%@:%@", 
		[self _instanceID], aKeyString];
}
 
@end

Higher Order Messaging (HOM)

Tags: Cocoa, NSInvocation, NSProxy, Objective-C

イントロダクション

-[NSObject performSelector:withObject]に複数の引数を渡す - boreal-kiss.comで少しだけ言及していたHigher Order Messaging (HOM)の例をいくつか挙げておく。なおCocoaにおけるHOMはMetaobjectによるMPWFoundationの機能の一部として利用することができる(ようである)。

ケース1

ボタンを押す(-[AppController buttonPressed:])とアラートを表示する(-[AppController openAlert])アプリケーションを考えよう。アプリケーションのコントローラー部分は以下のように記述されているとする。

@implementation AppController
 
-(IBAction)buttonPressed:(id)sender{
	[self openAlert];
}
 
-(void)openAlert{
	NSRunAlertPanel(@"Alert", @"This is an alert", @"OK", nil, nil);
}
 
@end

1秒後にアラート表示をさせたい場合は-[NSObject performSelector:withObject:afterDelay:]を用いると以下のように書き換えることができる。

-(IBAction)buttonPressed:(id)sender{
	[self performSelector:@selector(openAlert) withObject:nil afterDelay:1.0];
}

この書き方でももちろんかまわないが、HOMを用いるとメッセージ内容がより直感的に表現される。新しくNSProxyのサブクラス(DelayedTrampoline)を導入してHOM的な書き方をした場合は以下のようになる。

#import "DelayedTrampoline.h"
 
@implementation AppController
 
//New
-(IBAction)buttonPressed:(id)sender{
	[[self afterDelay:1.0] openAlert];
}
 
-(void)openAlert{
	NSRunAlertPanel(@"Alert", @"This is an alert", @"OK", nil, nil);
}
 
//New
-(DelayedTrampoline *)afterDelay:(NSTimeInterval)delay{
	return [DelayedTrampoline delayedTrampolineWithTarget:self 
			afterDelay:delay];
}
 
@end

@interface DelayedTrampoline : NSProxy {
	id _target;
	NSTimeInterval _delay;
}
 
-(id)initWithTarget:(id)aTarget afterDelay:(NSTimeInterval)delay;
+(id)delayedTrampolineWithTarget:(id)aTarget afterDelay:(NSTimeInterval)delay;
@end

@implementation DelayedTrampoline
 
-(id)initWithTarget:(id)aTarget afterDelay:(NSTimeInterval)delay{
	_target = aTarget;
	_delay = delay;
	return self;
}
 
+(id)delayedTrampolineWithTarget:(id)aTarget afterDelay:(NSTimeInterval)delay{
	return [[[[self class] alloc] initWithTarget:aTarget 
				afterDelay:delay] autorelease];
}
 
//Override
-(NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector{
	return [_target methodSignatureForSelector:aSelector];
}
 
//Override
-(void)forwardInvocation:(NSInvocation *)anInvocation{
	[anInvocation performSelector:@selector(invokeWithTarget:) 
		withObject:_target afterDelay:_delay];
}
 
-(void)dealloc{
	_target = nil;
	[super dealloc];
}
 
@end

以下に比較したい箇所だけを抜き出す。HOMの場合メッセージ(afterDelay:)の引数がメッセージ(openAlert)であるかのように書くことができることがわかる。これがHOMの”Higher Order”たる所以である。[NSObject performSelector:withObject:afterDelay:]を用いた従来の書き方よりもより直感的に理解できる表現だ。もちろん引数に書かれたメッセージは実際に引数を持つことができるため柔軟性も高い(例: -[NSObject performSelector:withObject]に複数の引数を渡す - boreal-kiss.com)。

//Normal
-(IBAction)buttonPressed:(id)sender{
	[self performSelector:@selector(openAlert) withObject:nil afterDelay:1.0];
}
 
//HOM
-(IBAction)buttonPressed:(id)sender{
	[[self afterDelay:1.0] openAlert];
}

ケース2

HOMは同じ内容を繰り返し記述しなければならない場合などにも便利だ。例えばdelegateメソッドを実行する際にターゲットであるdelegateが実際にメソッドを実装しているか確認する次のようなコードを大量に書いて(あるいはコピペして)骨が折れた経験はないだろうか。

if ([delegate respondsToSelector:@selector(doSomething)]){
	[delegate doSomething];
}

この場合あらかじめdelegateオブジェクトになるクラス(DelegateObject)にHOMを実装しておけば問題は回避可能だ。

#import "IfRespondsToTrampoline.h"
 
@implementation DelegateObject
 
-(IfRespondsToTrampoline *)ifRespondsTo{
	return [IfRespondsToTrampoline ifRespondsToTrampolineWithTarget:self];
}
 
@end

@interface IfRespondsToTrampoline : NSProxy {
	id _target;
}
 
-(id)initWithTarget:(id)aTarget;
+(id)ifRespondsToTrampolineWithTarget:(id)aTarget;
@end

@implementation IfRespondsToTrampoline
 
-(id)initWithTarget:(id)aTarget{
	_target = aTarget;
	return self;
}
 
+(id)ifRespondsToTrampolineWithTarget:(id)aTarget{
	return [[[[self class] alloc] initWithTarget:aTarget] autorelease];
}
 
//Override
-(NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector{
	return [_target methodSignatureForSelector:aSelector];
}
 
//Override
-(void)forwardInvocation:(NSInvocation *)anInvocation{
	[anInvocation invokeWithTarget:_target];
}
 
-(void)dealloc{
	_target = nil;
	[super dealloc];
}
 
@end

以下に比較したい箇所だけ抜粋する。delegateオブジェクトに上記のようなHOMが実装されていれば、メソッドがあれば実行、なければ何もしない(実際には内部でNSProxyによるNSInvalidArgumentExceptionが挙がる)というコードが一行で書けてしまう。

//Normal
if ([delegate respondsToSelector:@selector(doSomething)]){
	[delegate doSomething];
}
 
//HOM
[[delegate ifRespondsTo] doSomething];

-[NSObject performSelector:withObject]に複数の引数を渡す

Tags: Cocoa, DesignPatterns, NSInvocation, NSProxy, Objective-C

イントロダクション

あるメソッドを遅延して実行したい場合、-[NSObject performSelector:withObject:afterDelay]を用いることが多々ある。しかし対象のメソッドが複数の引数を持つものであった場合、この方法は直接的には用いることができなくなってしまう。そこでNSInvocationクラスとNSProxyクラスを用いて複数引数を持つメソッドでも適用できるように工夫する。なおこの方法はHigher Order Messaging(メッセージを引数に持つメッセージという意味合い)と呼ばれる。

問題の一例

例えば以下のようなコントローラークラスを考える。このコントローラーではUI中のボタン(Show Alert)が押されるとアラートが表示される仕組みになっている。

@implementation AppController
 
-(IBAction)buttonPressed:(id)sender{
	[self openAlertWithTitle:@"Alert" message:@"This is an alert."
		defaultButtonTitle:@"OK"];
}
 
-(void)openAlertWithTitle:(NSString *)aTitle
				message:(NSString *)aMessage
				defaultButtonTitle:(NSString *)aDefaultButtonTitle{
	NSRunAlertPanel(aTitle, aMessage, aDefaultButtonTitle, nil, nil);
}
 
@end

このままだと、ボタンが押された途端にアラートが表示され、ボタンの描画状態がプッシュ中のままになることがわかる。気持ちわるい。

そこで-[NSObject performSelector:withObject:afterDelay:]を用いてアラートを遅延表示させるのが得策だろう。しかし-[NSObject performSelector:withObject:afterDelay:]では-[AppController showAlertWithTitle:message:defaultButtonTitle:]を正しく実行できない。引数が複数あるためだ。それではどうすればよいだろうか。解決策のひとつとして複数の引数をひとつにまとめてしまう方法が考えられる。

NSInvocation

NSInvocationはメソッドをオブジェクト化したクラスである。デザインパターンで言うところのCommandパターンに相当するもので、これを利用することで上記問題を解決することができる。具体的には以下のような手順を踏むことになるだろう。

1. -[NSObject performSelector:withObject:afterDelay:]で本来実行したい複数引数を持つメソッドをNSInvocationオブジェクトとしてひとつにまとめてしまう(メソッドのオブジェクト化)
2. 作成したNSInvocationオブジェクトを実行するための新たなメソッド(引数はNSInvocationオブジェクトひとつのみ)を定義、それを-[NSObject performSelector:withObject:afterDelay:]で実行する。単一引数なので問題なし
3. NSInvocationオブジェクトの中身(本来実行したいメソッド)を実行する

以下では新しく-[AppController openDelayedAlertWithTitle:message:defaultButtonTitle:]としてアラートの遅延表示を実現している。

@implementation AppController
 
-(IBAction)buttonPressed:(id)sender{
	[self openDelayedAlertWithTitle:@"Alert" message:@"This is an alert."
		defaultButtonTitle:@"OK"];
}
 
-(void)openAlertWithTitle:(NSString *)aTitle
	message:(NSString *)aMessage
	defaultButtonTitle:(NSString *)aDefaultButtonTitle{
	NSRunAlertPanel(aTitle, aMessage, aDefaultButtonTitle, nil, nil);
}
 
//New
-(void)openDelayedAlertWithTitle:(NSString *)aTitle
	message:(NSString *)aMessage
	defaultButtonTitle:(NSString *)aDefaultButtonTitle{
 
	NSMethodSignature *aSignature = [[self class]
		instanceMethodSignatureForSelector:
		@selector(openAlertWithTitle:message:defaultButtonTitle:)];
	NSInvocation *anInvocation = [NSInvocation
		invocationWithMethodSignature:aSignature];
	[anInvocation setTarget:self];
	[anInvocation setArgument:&aTitle atIndex:2];
	[anInvocation setArgument:&aMessage atIndex:3];
	[anInvocation setArgument:&aDefaultButtonTitle atIndex:4];
	[anInvocation setSelector:
		@selector(openAlertWithTitle:message:defaultButtonTitle:)];
	[self performSelector:@selector(performInvocation:)
		withObject:anInvocation afterDelay:0.0];
}
 
//New
-(void)performInvocation:(NSInvocation *)anInvocation{
	[anInvocation invokeWithTarget:self];
}
 
 
@end

実行結果。アラート表示が遅延されボタンがプッシュ状態でなくなっているのがわかる。気持ちいい。

上記例からメソッドをオブジェクト化するというNSInvocationクラスの有用性が実感できた。反面、NSInvocationオブジェクトは作成するまでの手順が面倒なこともわかったと思う(例えば引数が10個あるメソッドをNSInvocationオブジェクト化するためには10回も-[NSInvocation setArgument:atIndex:]を書かないといけない)。実は適当なメッセージを送るとメッセージ内容をNSInvocationオブジェクトにしてくれる便利クラスが存在する。NSProxyだ。

NSProxy

NSProxyはデザインパターンで言うところのProxyパターンを実現するものである。NSProxyは自分が理解できないメッセージをとりあえずNSInvocationオブジェクトにしてしまうという機能を持っているのでこれを利用する。NSProxyはメッセージを受け取ると以下のような手順でNSInvocationオブジェクトを作成し、NSInvocationオブジェクトをどのように扱うのか指示を待つ。

1. -[NSProxy methodSignatureForSelector:]を呼び出しNSMthodSignatureオブジェクトを作成する。ただしNSMethodSignatureオブジェクトを作成するための必要な情報(ターゲット etc.)はメソッド内に適切に与えてやる必要がある
2. NSMethodSignatureオブジェクトを元にNSInvocationオブジェクトを作成する
3. -[NSProxy forwardInvocation:]を呼び出しメソッド内容の指示に従う

自動作成されたNSInvocationオブジェクトは-[NSProxy forwardInvocation:]の引数に渡されるので、あとはこのNSInvocationオブジェクトの扱い方を内部に記述してやればよい。以下ではNSProxyのサブクラスとしてTrampolineクラスを用いてNSInvocationオブジェクトを作成させている。AppControllerの中身の変更にも注目してもらいたい。

#import "Trampoline.h"
 
@implementation AppController
 
-(IBAction)buttonPressed:(id)sender{
	[self openDelayedAlertWithTitle:@"Alert" message:@"This is an alert."
		defaultButtonTitle:@"OK"];
}
 
-(void)openAlertWithTitle:(NSString *)aTitle
	message:(NSString *)aMessage
	defaultButtonTitle:(NSString *)aDefaultButtonTitle{
	NSRunAlertPanel(aTitle, aMessage, aDefaultButtonTitle, nil, nil);
}
 
//New
-(void)openDelayedAlertWithTitle:(NSString *)aTitle
	message:(NSString *)aMessage
	defaultButtonTitle:(NSString *)aDefaultButtonTitle{
	[[self trampoline] openAlertWithTitle:aTitle
		message:aMessage defaultButtonTitle:aDefaultButtonTitle];
}
 
-(void)performInvocation:(NSInvocation *)anInvocation{
	[anInvocation invokeWithTarget:self];
}
 
//New
-(Trampoline *)trampoline{
	return [Trampoline trampolineWithTarget:self
		selector:@selector(performInvocation:)];
}
 
 
 
@end

@interface Trampoline : NSProxy {
	id _target;
	SEL _selector;
}
 
-(id)initWithtarget:(id)aTarget selector:(SEL)aSelector;
+(id)trampolineWithTarget:(id)aTarget selector:(SEL)aSelector;
 
@end

@implementation Trampoline
 
-(id)initWithtarget:(id)aTarget selector:(SEL)aSelector{
	_target = aTarget;
	_selector = aSelector;
	return self;
}
 
+(id)trampolineWithTarget:(id)aTarget selector:(SEL)aSelector{
	return [[[[self class] alloc] initWithtarget:aTarget selector:aSelector]
		autorelease];
}
 
//Override
-(NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector{
	return [_target methodSignatureForSelector:aSelector];
}
 
//Override
-(void)forwardInvocation:(NSInvocation *)anInvocation{
	[_target performSelector:_selector withObject:anInvocation afterDelay:0.0];
}
 
-(void)dealloc{
	_target = nil;
	[super dealloc];
}
 
@end

References

• Higher Order Messaging (pdf)

[iPhone] cocos2dを静的ライブラリ化して使う

Tags: cocos2d, iPhone

[イントロダクション]

cocos2d for iPhoneはiPhoneアプリケーション製作用のフレームワークで、主に2Dゲームを作る際の基盤に用いられているようである。UIKitより使い勝手が良いと思える点は以下の通り。

1. オブジェクトの扱い方がFlashの感覚にかなり近い。Cocoa touch特有のframeやboundsを気にしなくてよく、-[Sprite addChild:]などおなじみの操作も行える。
2. メモリ管理をほとんど気にしなくてよい。cocos2dオブジェクトに関しては内部で適切に処理されるようになっている(ようである)。
3. シーン遷移機能が標準装備されている。エフェクトの種類も豊富。

個人的にはFlash的に操作できるという点が一番の恩恵だと思っており、最近はXcodeのプロジェクト作成時にcocos2d用テンプレートしか使っていない。テンプレートを使うのであれば例えばCocos2d – 2D OpenGL for the iPhone made Easy. Part 1.に簡素なものがある。自分で作るのであれば【Xcode】設定しておくと便利なカスタマイズいろいろが参考になる。

[追記: 2009/09/02]

cocos2d for iPhone v0.8.1-betaよりプロジェクトテンプレートが用意されている。詳しくはrelease_notes:0_8_1_beta [cocos2d for iPhone]のTemplateの項参照。

[本題]

このCocos2d for iPhoneだが、ライブラリの状態で配布されていない。そのまま使用するのであれば大量のcocos2dソースファイルをプロジェクトに追加する形になる。これはコンパイルに結構時間がかかるし、ソースファイルに誤って書き込んでしまう可能性がある。そこでcocos2dを静的ライブラリ化することにする。以下で使用したのはcocos2d for iPhone v0.8。

[手順0. その前に]

実は、単純に静的ライブラリを作ってもiPhoneシミュレータとiPhone実機両方で使用することができない。というのはiPhoneシミュレータとiPhone実機のアーキテクチャ(ハードの構造)が異なるためである。したがって両者で動くようなライブラリを作るのには一工夫必要となる。

[手順1. iPhoneシミュレータ用静的ライブラリを作る]

1. とりあえずiPhoneシミュレータ用を作る(iPhone用が先でもかまわない)。cocos2dプロジェクト内に新規Static Libraryを追加(ターゲット追加 > 新規ターゲット > Cocoa touch Static Library)、名前を”cocos2d-simulator”とする(名前はシミュレータ用であると自分でわかればなんでもよい)。
2. 必要なファイル(cocos2dだけであればcocos2dフォルダ内のファイル一式)をターゲット配下に追加する。具体的には「ヘッダをコピー」にヘッダファイルを、「ソースをコンパイル」にソースファイルを、「バイナリをライブラリにリンク」に使用フレームワーク(Foundation, UIKit, CoreGraphics, OpenGLES, QuartzCoreの5種類)を追加する。



3. ターゲット情報のアーキテクチャの項目のベースSDKを”iPhone Simulator 3.0″にする(バージョンはお好みで)。



4. ターゲットを”cocos2d-simulator”にしてビルドするとbuild配下に”libcocos2d-simulator.a”が出来ている(シミュレータ用静的ライブラリ完成)。ReleaseバージョンやDebugバージョンなどはお好みで。

[手順2. iPhoneOS用静的ライブラリを作る]

上記シミュレータ用ライブラリ作成手順とほぼ同じ。

• cocos2dプロジェクト内に新規Static Libraryを追加、名前を”cocos2d-iphoneos”とする(名前は適宜)。
• ターゲット配下に必要なファイルを追加する(内容は上記シミュレータ用のものと同様)。
• ターゲット情報のアーキテクチャの項目のベースSDKを”iPhone Device 3.0″にする(バージョンはお好みで)
• ターゲットをビルドして”libcocos2d-iphoneos.a”を作成(iPhone用静的ライブラリ完成)。

[手順3. 上記二種類の静的ライブラリをマージする]

“lipo”と呼ばれるコマンドラインツールがマージをしてくれる。詳細はiPhone OS用のほぼFrameworkの作り方やHow to (almost) create your own iPhone OS frameworkが詳しい。

1. cocos2dプロジェクト内に新規Shell Script Targetを追加する(ターゲット追加 > 新規ターゲット > Other > Shell Script Target)、名前を”cocos2d-0.8″とする(名前は自分で識別できれば何でもかまわない)。



2. ターゲット配下の”スクリプトを実行”に以下のコマンドを記述する。コマンドを注意深く見てもらえばわかると思うが、シミュレータ・iPhone用のライブラリ名は自分が作成したものに適宜変更する必要がある。マージ後のライブラリ名はお好みで。

rm -rf build/${BUILD_STYLE}-iphoneos/cocos2d-0.8-${BUILD_STYLE}.a

lipo -create "build/${BUILD_STYLE}-iphoneos/libcocos2d-iphoneos.a" \
"build/${BUILD_STYLE}-iphonesimulator/libcocos2d-simulator.a" \
-output "build/${BUILD_STYLE}-iphoneos/cocos2d-0.8-${BUILD_STYLE}.a"



3. ターゲットを”cocos2d-0.8″に設定してビルドするとマージされた静的ライブラリが作成される。上記のコマンドの例だと例えば”build/Release-iphoneos/libcocos2d-iphoneos.a”と”build/Release-iphonesimulator/libcocos2d-simulator.a”のファイルをマージして”build/Release-iphoneos/cocos2d-0.8-Release.a”が作成されることになる。マージされたライブラリはシミュレータでもiPhone実機でも使うことができる。

[実際の使用方法]

上記手順でシミュレータでもiPhone実機でも使える静的ライブラリ”cocos2d-0.8-Release.a”ができているとする。このファイルだけでcocos2dが使えるのかと思いきや、ヘッダーファイルの実態への参照を用意しなくてはいけない。具体的には以下の二点の作業を行えばプロジェクト内でcocos2dが動作する。

1. プロジェクトに”cocos2d-0.8-Release.a”を(例えばFrameworksの項目に)追加。
2. プロジェクト情報のヘッダ検索パスにcocos2dプロジェクト全体を追加(ファインダーからドラッグでok)。ヘッダーファイルのあるcocos2dフォルダだけでもよい(要はどこにcocos2dに関係したヘッダーファイルがあるかXcodeに教える必要があるというだけである)。ヘッダ検索オプションの”再帰的”にチェックを忘れずに。

-[NSObject performSelector:]の返り値

Tags: Cocoa, iPhone, Objective-C

まとめ

• -[NSObject performSelector:]の返り値として不適切なものが存在する。
• それら不適切なものを扱う場合の対処法について。

イントロダクション

NSObjectのインスタンスメソッド

- (void)performSelector:(SEL) aSelector

はvoid型となっているが、「引数にセットされたメソッドの返り値」を自分の返り値に持つことができる。ただしその場合、-[NSObject performSelector:]の返り値はid型(オブジェクトポインタ)になるので適切にキャストしてやる必要がある。例えば、以下のようなNSStringを返すメソッドを持つTest1クラスを考える。

@implementation Test1
 
-(NSString *)stringValue{
	return @"Hello";
}
 
@end

このTest1クラスに-[NSObject performSelector:]を使って-[Test1 stringValue]を呼び、NSStringにキャストして返り値を受け取るとたしかに@”Hello”が返ってきていることがわかる。

Test1 *test1 = [[Test1 alloc] init];
NSString *stringValue = (NSString *)[test1 performSelector:@selector(stringValue)];
NSLog(@"%@", stringValue);// Hello

本題

-[NSObject performSelector:]の返り値はid型であり、id型はオブジェクトへのポインタであると説明した。つまり、-[NSObject performSelector:]は「オブジェクトではないものを返り値とするメソッド」の返り値を受け取ることができない可能性があることがわかる。例を見てみよう。Test2クラスに以下のようなメソッドがあるとする。どのメソッドの返り値もオブジェクトではない。

@implementation Test2
 
-(BOOL)boolValue{
	return YES;
}
 
-(int)intValue{
	return 10;
}
 
-(float)floatValue{
	return 2.0;
}
 
-(CGPoint)point{
	return CGPointMake(100.0, 100.0);
}
 
@end

先ほどと同様にこれらのメソッドを-[NSObject performSelector:]を使って呼び出し、返り値を確認すると以下のような結果になった。

Test2 *test2 = [[Test2 alloc] init];
 
//warning: cast from pointer to integer of different size
BOOL boolValue = (BOOL)[test2 performSelector:@selector(boolValue)];
NSLog(@"%i", boolValue);// 1
 
int intValue = (int)[test2 performSelector:@selector(intValue)];
NSLog(@"%i", intValue);// 10
 
//error: pointer value used where a floating point value was expected
float floatValue = (float)[test2 performSelector:@selector(floatValue)];
NSLog(@"%f", floatValue);
 
//error: conversion to non-scalar type requested
CGPoint point = (CGPoint)[test2 performSelector:@selector(point)];
NSLog(@"%@", NSStringFromCGPoint(point));

結果をまとめると以下のようになる。

• 返り値BOOLについては警告が出たが返り値の受け取りができた。
• 返り値intについては警告は出ず返り値の受け取りができた。
• 返り値floatについてはコンパイルエラーが生じ実行できなかった。
• 返り値CGPointについてはコンパイルエラーが生じ実行できなかった。

対処法

上記のテスト結果から、-[NSObject performSelector:]から「オブジェクトではないものを返り値とするメソッド」の返り値を受け取るためには何かしらの工夫をしなければならないことがわかった(int型・BOOL型などの例外もある)。以下に二種類の対処法を挙げておく。

1. -[NSObject performSelector:]で呼び出すメソッドの返り値をオブジェクトにしておく。
2. -[NSObject performSelector:]の代わりに[NSInvocation invoke]を用いる。

順に見てみよう。

対処法1

二つ目の対処法より簡単である。返り値int, BOOL, floatについてはNSNumberオブジェクトによるラッピング、返り値CGPoint(CGRect, CGSizeなども含む)についてはNSStringオブジェクトに変換することで簡単に対処できる。以下に、Test2クラスの4メソッドの返り値を全てオブジェクトに変更したTest3クラスを挙げる。

@implementation Test3
 
-(NSNumber *)boolValue{
	return [NSNumber numberWithBool:YES];
}
 
-(NSNumber *)intValue{
	return [NSNumber numberWithInt:10];
}
 
-(NSNumber *)floatValue{
	return [NSNumber numberWithFloat:2.0];
}
 
-(NSString *)point{
	return NSStringFromCGPoint(CGPointMake(100.0, 100.0));
}
 
@end

この場合、各メソッドの返り値はオブジェクトであるため、それらオブジェクトから必要な値を復元してやればよい。

Test3 *test3 = [[Test3 alloc] init];
 
BOOL boolValue = [[test3 performSelector:@selector(boolValue)] boolValue];
NSLog(@"%i", boolValue2);// 1
 
int intValue = [[test3 performSelector:@selector(intValue)] intValue];
NSLog(@"%i", intValue2);// 10
 
float floatValue = [[test3 performSelector:@selector(floatValue)] floatValue];
NSLog(@"%f", floatValue2);// 2.000000
 
CGPoint point = CGPointFromString([test3 performSelector:@selector(point)]);
NSLog(@"%@", NSStringFromCGPoint(point2));// {100, 100}

対処法2

-[NSObject performSelector:]の代わりにNSInvocationを用いると、返り値がオブジェクトであろうとなかろうと受け取ることが可能になる。例えば、-[Test2 floatValue]の返り値を受け取る場合には、以下のような手続きをとる。

Test2 *test2 = [[Test2 alloc] init];
 
float floatValue;
NSMethodSignature *aSigniture 
        = [[test2 class] instanceMethodSignatureForSelector:@selector(floatValue)];
NSInvocation *anInvocation 
        = [NSInvocation invocationWithMethodSignature:aSigniture];
[anInvocation setSelector:@selector(floatValue)];
[anInvocation setTarget:test2];
[anInvocation invoke];
[anInvocation getReturnValue:&floatValue];
NSLog(@"%f", floatValue);// 2.000000

NSInvocationを用いると汎用性は高くなるが、一般的にソースが煩雑になる。

参考

• NSInvocationの作成 - Objective-Audio

Next Page →

• About

  Japanese / English
  
  

  Flash, Flex, AIR等の技術メモ、最近は主にiPhone OS、Cocoaに傾倒中。Flashの習作はHPに保管しています。
  
  

  Contact: info [AT] boreal-kiss.com

• Search

• iPhone Apps

  

• Recent entries

  • Associative Storage: カテゴリに疑似インスタンス変数を追加
  • Higher Order Messaging (HOM)
  • -[NSObject performSelector:withObject]に複数の引数を渡す
  • [iPhone] cocos2dを静的ライブラリ化して使う
  • -[NSObject performSelector:]の返り値
  • [ActionScript] モンハンでAbstract Factory
  • [iPhone][App] KanjiName - Your Japanese Name
  • Design Patterns for ActionScript
  • [iPhone][App] Nespresso Stock CheckerにGPS機能追加
  • [iPhone]スタンフォード大学iPhone app講義のpodcast第8, 9回
  • - (CGSize)sizeWithFont:(UIFont *)font
  • [iPhone]スタンフォード大学iPhone app講義のpodcast第6, 7回
  • [iPhone] HTMLリンクのようなUIButtonのサブクラス
  • [iPhone]スタンフォード大学iPhone app講義のpodcast第5回
  • [iPhone]スタンフォード大学iPhone app講義のpodcast第4回

• Tags

  ActionScript AIR App Books Cocoa cocos2d DesignPatterns Firefox FLASH FlashPlayer10 Flex Flickr Git iPhone JavaScript Lang-8 License Mac Misc Muxtape MySQL NSInvocation NSProxy Objective-C Papervision3D PHP Podcast Processing Rails Ruby SVN Tumblr UIKit WEBサービス WordPress おっぱい まとめ ドット絵 ドラクエ ファミコン ブログでレベルアップ ブログパーツ メモ 他人のブログパーツ 洞窟物語

• AIR

  • Dot3D
  • Nespresso Stock Checker
  • SimpleLogger

• Flash

  • Book Reviews
  • FLASH Boreal Kiss
  • Ruby唐辛子
  • Sketch
  • Tube3D
  • ブログで勇者を育成

• Recommended

  • 

    Cocoaフレームワークについて深く掘り下げておりその偉大さを実感できる。一般的なデザインパターンをObjective-Cを用いて実践するといった本ではない。いくつかの有名なデザインパターンがCocoa発祥なのだから。超絶オススメ。

    
    

  • 

    ActionScriptの知識はこの一冊と言語リファレンスのみでOK。1年以上前の購入書籍にも関わらず、いまだに読んだりする。邦訳版もアリ。

    
    

  • 

    メンテナンスが容易、拡張が容易なプログラムを書くために必要な思想と具体的な処方について学べる本。デザインパターンについてActionScriptを用いて解説しているという点で貴重な一冊。

    
    

Find It

Credits

Powered by Vertigo & WordPress