イベントのスクリプティング

Andrew Clinick
Microsoft Corporation

April 9, 2001
日本語版最終更新日 2001 年 6 月 5 日

この記事は、もともと MSDN Online Voices のコラム "Scripting Clinic" に掲載されたものです。

イベントのスクリプトを作成することは、非常に簡単なことです。マイクロソフトやサードパーティからの多くのアプリケーションを使用して、アプリケーションが提供するオブジェクトから発生するイベントに応答するスクリプトコードを記述できます。アプリケーションはイベントを通じて適切な時点で呼び出しを行い、イベントハンドラのコードを記述することにより、その呼び出しに応答することだけを理解しておけばよいので、これは開発者にとってスクリプトを作成する場合の優れた方法です。少なくとも理論上はこのとおりです。しかし実際には、イベントはアプリケーションによって数多くの方法で処理され、実装されています。したがって、イベントのスクリプトを作成する最適な方法は何かということに関して、すぐに混乱を生じてしまいます。

私は、この機会にこういった混乱を整理するために、一般的に評判のよいアプリケーション、特に Internet Explorer、Windows® Script Host、および Windows® Script Components でイベント処理スクリプトを記述するためのさまざまな選択肢を調査してみようと考えました。

スクリプトエンジンがイベントを処理する方法

各アプリケーションでイベントを処理する方法を詳しく調査する前に、スクリプトエンジン (アプリケーション内で実際にスクリプトコードを実行するコンポーネント) がイベントを処理する方法を見てみましょう。アプリケーションの作成者がイベント処理を有効にするメカニズムは本質的に 2 通りあります。1 つは組み込みまたは "automagic"(自動的な) サポートで、もう 1 つは関数またはサブルーチンを呼び出すメカニズムです。

"Automagic" (自動的な) サポート

JScript® と Visual Basic® Scripting Edition の両方の Microsoft® Windows® スクリプトエンジンは、名前付け規則を使ってイベントのスクリプトを結び付ける組み込みのメカニズムを提供します。読者が VBScript のプログラマであれば、おそらく Visual Basic® および VBScript のイベントハンドラに対する Object_Eventname という名前付け規則に既に馴染みがあるでしょう。アプリケーションがスクリプトエンジンにオブジェクトを提供し、スクリプトエンジンを Connected モードにすると、イベントが発生するたびに正しい名前付け規則を持つサブルーチンが呼び出されます。たとえば、スクリプトが "order" という名前のオブジェクトを持ち、そのオブジェクトが "onNew" というイベントを持つ場合、そのサブルーチンは order_onNew() になります。"automagic" による結び付けが機能するには、スクリプトがコンパイルされるときに、スクリプトエンジンがそのオブジェクトを使用できる必要があります。

おそらく、VBScript プログラマにとっては耳新しいことではないでしょう。しかし、私たちは JScript がなぜこのメカニズムをサポートしないのですか、という質問をよく受けます。 JScript は組み込みのイベントバインディング名前付け規則をサポートします。ただし、残念ながらあまりよく知られてはいません。私たちが JScript 3 を作り上げる際に、JScript にこのメカニズムを追加する最善の方法は何かということについて、スクリプトチーム内で相当の議論が交わされました。VBScript の表記法に従うべきか,それとも何か新しいことを行うべきか。私は Object_Eventname という規則が実際のところ JScript の精神にはそぐわないと感じていました。さらに、この名前付け規則を使用しているコードが既に存在している可能性があることも認識しました。したがって、バージョン 3 にこれを追加することは、重大な互換性の問題を引き起こします。

JScript は C に似た言語であると言われているので (Jscript は Java とはまったく似ていない言語です。これは、JScript でのイベントの処理方法の次によく受けるもっとも共通した質問です)、名前付け規則として提案された代案は Object:: Eventname でした。order オブジェクトの例を再度使うと、onNew イベントの JScript イベントハンドラは order::onNew になります。これを説明するために、私は Visual Basic と Windows Script Control を使って簡単なスクリプトホストを作成したので、イベントハンドラを試してみることができます。このプログラムは、3 つのイベント onNew、onSave、および onDelete を持つ order オブジェクトと、スクリプトコードを記述できる簡単なテキストエディタを提供します。

図 1. 実行中の Event Test Bed アプリケーション

関数/サブルーチンの呼び出し

アプリケーションがスクリプトエンジンをホストする (ホストの例には Internet Explorer、 IIS、および Windows Script Host などがあります) ときは、常にそのアプリケーションはスクリプトコードで記述されたすべての関数またはサブルーチンにアクセスできます。ホストアプリケーションは関数を参照できるだけでなく、その関数を呼び出すことができます。アプリケーションはこのコードを直接呼び出せる能力を使って、スクリプトエンジンへのイベントバインディングを供給する別のメカニズムを提供します。ホストアプリケーションは、イベントに応答する組み込みの機能を使用するのではなく、オブジェクトが起動した任意のイベントを処理するために、適切なスクリプト関数を呼び出すことができます。ホストアプリケーションは、このメカニズムを使って、イベントハンドラに対して別の構文を定義できます。これは優れた機能ですが、スクリプトでイベントに応答する方法に混乱を生じる結果になります。ホストアプリケーションは、さまざまな名前付け規則やコーディング技法を使用できます。たとえば、 order オブジェクトの例ではアプリケーション内に実装される onNew イベントのイベントハンドラを持つことができ、その上スクリプト内から orderOnNew 関数として呼び出すこともできます。

Internet Explorer のイベント

Internet Explorer は、非常に多くの異なる方法でイベントを処理するので、イベントドリブンスクリプトに関する混乱の主な根源になっています。ここで明らかな疑問は、Internet Explorer は同じ結果を得るためになぜそんなに多くの方法を必要としているのかということです。その主な理由は HTML のイベントが本当の意味で標準化されていないことにあります。そのため、IE はどのイベントを HTML に結びつけるかということと、ActiveX® コントロールなどのほかのブラウザがサポートしない機能を処理するために、多くの方法をサポートする必要があります。この結果、今日起こり得るほぼすべてのコンテキストを IE で実行できるのでエンドユーザーにとってはすばらしいことですが、スクリプトの作成者の作業をより複雑なものにしています。

インラインスクリプトハンドラ

インラインスクリプトハンドラは、IE と Netscape の両方でサポートされているので、 IE のイベント処理ではおそらくもっとも広範に使用されているメカニズムです。基本的な原則は、HTML 要素の内部にスクリプトを追加することで、ブラウザがすべての結び付けを行います。以下に例を示します。

<span id="testinline" onclick='alert("inline handler - JScript")'>Click me inline - JScript</span>

ユーザーが span 要素に囲まれているテキストをクリックすると、onclick 属性に指定されたコードが呼び出されます。このメカニズムは少量のコードの場合は優れていますが、多くのスクリプトを記述する必要がある場合は、扱いにくいものになります。このイベントメカニズムは VBScript と JScript の両方で機能します。

ここで実際に行われていることは、Internet Explorer がそのスクリプトコードを指定してスクリプトエンジンを呼び出し、エンジンに匿名関数 (名前のない関数) を作成するように指示します。VBScript は匿名関数をサポートしないので、VBScript の知識のある読者はどのようにこれを行っているかおそらく不思議に思うことでしょう。実際には、VBScript はそのスクリプトを含む "anonymous" という名前のサブルーチンを作成し、その後イベントに結び付けられる関数へのポインタを返します。

関数ポインタ

JScript のあらゆる関数は最上級のオブジェクトです。JScript では関数をポインタとして渡すことができ、そのポインタを使用して関数を呼び出すことができます。これは、イベントハンドラの結び付けに柔軟性をもたらし、1 つ以上のイベントを処理するために同じ関数を使用することを可能にしています。関数ポインタイベントをセットアップするには、オブジェクトの EventName プロパティに関数のポインタを設定するだけです。JScript ではこれを以下のように非常に簡単に行えます。

window.onclick=foo
function foo()
{
   alert('you clicked on the window')
}

VBScript の最初のリリースでは、window.onclick に foo を設定すると、VBScript はポインタを受け取るのではなく foo を呼び出すので、関数ポインタを使用する方法はありませんでした。VBScript 5.0 では GetRef メソッドが導入されました。これは関数への参照を作成するので、以下のようにイベントハンドラを設定できます。

set window.onclick=GetRef("foo")
function foo()
   alert('you clicked on the window')
end function

<Script> ブロック - イベントハンドラ

ここまで使用してきたイベントハンドラは、HTML イベントに対しては適切に機能しますが、ページ上の ActiveX オブジェクトのカスタムイベントのイベントハンドラを記述する方法は提供しません。このサポートを提供するために、Internet Explorer は <script> ブロックに対する拡張を導入し、以下のようにスクリプトがどのオブジェクトの、どのイベントに対するものかを指定できるようにしました。

<span id="testscript">Click me script block handler - JScript</span>
<script language=JScript for=testscript event="onclick">
alert("script block handler - JScript")
</script>
<br>

名前付け規則

最後に、Internet Explorer 固有のイベント結び付けメカニズムは、オブジェクト名とイベント名を含む関数の命名法で成り立ちます。関数名が objectname.eventname の形式の場合、IE は以下のように自動的に関数とイベントの結び付けを行います。

<span id="testnaming">Click me naming - JScript</span>
<script language=JScript>

function testnaming.onclick()
{
   alert("script naming - JScript")
}
</script>

注意: このメカニズムは JScript だけで機能します。

Automagic

すべての IE 固有のイベント処理メカニズム以外に、スクリプトエンジンが提供する組み込みの "automagic" (自動的な) 結び付けも使用できます。このメカニズムを使用する場合に重要なことは、この結び付けがいつ行われるかを理解することです。ページが読み込まれるときにオブジェクトまたは HTML 要素が使用できる場合、スクリプトエンジンはイベントバインディングを行います。ただし、(たとえば innerHTML を設定することによって) ページが読み込まれた後にオブジェクトまたは要素が追加されると、スクリプトエンジンはイベントの結び付けを行いません。このメカニズムが優れている点は、ActiveX コントロールイベントに応答するために使用できることです。

<span id="testscriptbuiltin">Click me Built In - JScript</span>
<script language=JScript>

function testscriptbuiltin::onclick()
{
alert("script naming - JScript")
}
</script>

<br>

<span id="testscriptbuiltin">Click me Built In - VBScript</span>
<script language=VBScript>

sub testscriptbuiltin_onclick()
   alert("script naming - VBScript")
end sub
</script>

これらのイベントハンドラの実行例を表示します。

WSH のイベント

Windows Script Host のイベント結び付けメカニズムは Internet Explorer よりもはるかに単純で、イベントを結び付ける方法を 2 つだけ提供します (2 つは 5 つよりもよいことだとは思いませんか !)。とはいえ、WSH でイベントを処理するコードを記述することはちょっとした難問で、イベントが発生するときにスクリプトが依然として実行中であることを保証することすら簡単なことではありません。WSH スクリプトはスクリプトの最終行を実行した直後に終了するので、このことが問題になります。処理したいと思っているイベントが発生する前に終了してしまう可能性もあります。この問題を扱うために、 WScript.Sleep メソッド (詳細については、http://www.microsoft.com/japan/msdn/library/ja/script56/html/wsMthSleep.asp を参照してください) を使用して、長時間休止するループを作成することをお勧めします。イベントが発生した後は、WScript.Quit メソッドを使用してスクリプトを終了します。 (私たちはこれを行うことが面倒であることがわかっています。したがって、これを解決することが WSH 5.6 の次のバージョンでの機能強化のリストに含まれています。) 確実にイベントハンドラが呼び出される方法を実現した後は、 2 つのイベント処理メカニズムのどちらを使用するかを決定する必要があります。

WSH は、"automagic" と名前付け規則の両方のイベント結び付けをサポートします。WSH 1.0 で導入された名前付け規則システムは、WScript.Createobject を使用して作成されたオブジェクトからのイベントに応答する方法を提供します。WSH 1.0 の頃は、WSH で外部オブジェクトを作成する方法がなかったので、このメカニズムが必要でした。WScript.CreateObject は VBScript CreateObject と似ていますが、イベントハンドラ関数の名前付け規則を定義する 2 番目の引数が追加されています。以下に例を示します。

Set myobject = WScript.CreateObject("someobjectwithevents","myobject_")

この場合、WSH は Someobjectwithevents オブジェクトのインスタンスを作成し、イベントが発生するときに myobject_ で始まり、イベント名で終わる任意の関数が呼び出されます。WSH は、内部的にイベントを処理し、スクリプトエンジンの名前付け規則に一致する関数を呼び出すことにより、これを達成しています。"automagic" イベント結び付け構文は object_eventname なので、一般的に VBScript ではこのことによる大きな影響はありません。しかし、JScript では object::eventname が機能しないので、状況はやや異なります。以下に、CreateObject イベントバインディングの例を示します。

set myorder2 = WScript.CreateObject("ordersystem.clsorder","myorder2_")
myorder2.neworder(1)

sub myorder2_onNew()
   Wscript.echo "new order received from myorder2"
end sub

Windows Script チームは、WScript.CreateObject メカニズムが混乱を引き起こしたことを認識していたので、WSH 2.0 では .wsf ファイルに <object> 要素を導入しました。<object> 要素は、1 つの例外を除けば HTML の <object> 要素とほぼ同じです。<object> 要素で定義されるオブジェクトが起動するイベントは、既定ではファイル内のスクリプトコードに結び付けられません。イベントの結び付けを有効にするには、以下のように <object> 要素の Events 属性を True に設定する必要があります。

<job>
<object progid="ordersystem.clsorder" id="myorder" events="true"/>
<script language="vbscript">
sub myorder_onNew()
   Wscript.echo "new order received myorder"
end sub
myorder.neworder(1)
wscript.sleep 5000
</script>
</job>

WSH には、スクリプトが読み込まれた "後" に作成されたオブジェクトのイベントに結び付ける最終的な機能が含まれています。これは、VBScript の CreateObject または JScript の新しい ActiveXObject を使って作成されるオブジェクトで役に立ちます。既に作成されているオブジェクトのイベントへの結び付けおよび結び付け解除のために、WScript の ConnectObject メソッド、 WScript.ConnectObject があります。

set myorder3 = createobject("ordersystem.clsorder")

wscript.connectobject myorder3,"myorder3_"

myorder3.neworder(1)
sub myorder3_onNew()
   Wscript.echo "new order received from myorder3"
end sub

Windows Script Components

Windows Script Components の .wsc ファイルは、 .wsf ファイルと同じコンポーネントによって処理されます。したがって、Events 属性を含む <object> 要素が同じ機能を提供します。ただし、Wscript.CreateObject メソッドと Wscript.ConnectObject メソッドは WSH 固有のものなので、WSH の外部では使用できません。

まとめ

イベントの結び付けに何が使用できるかを理解すれば、イベントドリブンのプログラミングによりアプリケーションのスクリプトの作成がかなり容易になります。ここまで示してきたように、イベントハンドラを記述するための最適なメカニズムを判断することはかなり複雑になる可能性があります。各アプローチの相対的な長所を調べ、スクリプトを作成する作業が過度に複雑にならないように必要条件を満たすアプローチを選択することに注意を払います。私たちは、スクリプトの作成を容易にするためのフィードバックやご意見をいつもお待ちしています。いつでもご自由に(英語で) msscript@microsoft.com にメールをください。また、msnews.microsoft.com のニュースグループもご利用ください。

Andrew Clinick は、Microsoft Script Technology グループのプログラムマネージャであり、スクリプトに関係するものならば、おそらく何らかの形で彼が関わっています。