WebKit Plug-in 関連のプロトコルは３つある。
- Mac Dev Center: WebPlugIn Protocol Reference
- Mac Dev Center: WebPlugInContainer Protocol Reference
- Mac Dev Center: WebPlugInViewFactory Protocol Reference
WebPlugIn は、初期化や終了時、プラグインの処理が必要となるタイミングで WebKit側からコールバックされるメソッドが定義されている。ここにプラグインのメインとなる処理を記述する。
WebPlugInContainer はプラグインを格納しているアプリケーション（container）へアクセスするためのメソッドが定義されている。
最後の WebPlugInViewFactory はプラグインのインスタンスを生成するファクトリメソッドが定義されている（プラグインのクラスは NSViewのサブクラスとして定義するののでこういう名前が付いている）。
※WebPlugIn と WebPlugInContainer は非形式 (informal) プロトコル
それぞれの関係はこんなイメージになる。
WebPlugInViewFactory はプラグインクラスではなく別のクラスで実装してもかまわない。また WebPluginContainer プロトコルを実装したインスタンスは、プラグインインスタンス生成時に呼び出される +[WebPlugInViewFactory plugInViewWithArguments:] の引数（WebPlugInContainerKey）から取得できる。
さてこれらをふまえて自動生成された各メソッドをざっと眺めてみよう。
+ (NSView *)plugInViewWithArguments:(NSDictionary *)newArguments
{
return [[[self alloc] _initWithArguments:newArguments] autorelease];
}
WebPlugInViewFactory で定義されたクラスメソッド。内部定義してあるメソッドを呼び出している。
内部定義のメソッドはカテゴリで定義されている。
@interface WebkitPlugInStudyView (Internal)
- (id)_initWithArguments:(NSDictionary *)arguments;
@end
@implementation WebkitPlugInStudyView (Internal)
- (id)_initWithArguments:(NSDictionary *)newArguments
{
if (!(self = [super initWithFrame:NSZeroRect]))
return nil;
return self;
}
ひな形のソースでは矩形サイズが０のインスタンスを作成して返している。
続いて WebPlugIn（非形式プロトコル）で定義されたメソッドが並ぶ。中身は基本的に何も書かれていない。
// WebPlugIn informal protocol
- (void)webPlugInInitialize
{
// This method will be only called once per instance of the plug-in object, and will be called
// before any other methods in the WebPlugIn protocol.
// You are not required to implement this method. It may safely be removed.
}
- (void)webPlugInStart
{
// The plug-in usually begins drawing, playing sounds and/or animation in this method.
// You are not required to implement this method. It may safely be removed.
}
- (void)webPlugInStop
{
// The plug-in normally stop animations/sounds in this method.
// You are not required to implement this method. It may safely be removed.
}
- (void)webPlugInDestroy
{
// Perform cleanup and prepare to be deallocated.
// You are not required to implement this method. It may safely be removed.
}
- (void)webPlugInSetIsSelected:(BOOL)isSelected
{
// This is typically used to allow the plug-in to alter its appearance when selected.
// You are not required to implement this method. It may safely be removed.
}
- (id)objectForWebScript
{
// Returns the object that exposes the plug-in's interface. The class of this object can implement
// methods from the WebScripting informal protocol.
// You are not required to implement this method. It may safely be removed.
return self;
}
プラグイン開発はこれらのメソッドをコーディングすることになる。
次回は Safari へ組み込んで動作を確認してみよう。
+++++ WebKit Plug-in シリーズ +++++
+++++ WebKit Plug-in 関連情報 +++++
- Mac Dev Center: WebKit Plug-In Programming Topics: Introduction to WebKit Plug-in Programming Topics
- Mac Dev Center: WebPlugIn Protocol Reference
- Mac Dev Center: WebPlugInContainer Protocol Reference
- Mac Dev Center: WebPlugInViewFactory Protocol Reference
