(本ライブラリをCodePlexでプロジェクト化しました : http://yieldawait.codeplex.com/)
コードの途中で実行を一時停止できるyeild文を使って、指定したイベントの発生をコードの途中で待機できるようにするライブラリを作りました。どこに投稿すればよいか分からず、場外れでしたらすみません。この場でいくつかご意見いただければと思い、ここにディスカッションで投稿しました。
[ダウンロード]
ライブラリは以下のリンクからダウンロードできます。
EventWaitingCore.zip:
http://cid-6d750b1d390978fd.office.live.com/self.aspx/Public/1%20EventWaitingCore.zip
[使い方]
この中で、ライブラリ自体は「WaitCore.cs」ファイル1つに集約しています。(その他の詳細はこちらに説明があります) ライブラリは次のように使って、コードの途中でイベントを待機できるようにします。
using SimonPG.WaitCore; // ←[A]
IEnumerable TestFunc(EventWaiter waiter) { // ←[B]
...処理A...
yield return waiter.Wait(button1, "Click"); // ←[C]
...処理B...
}
void Form_Load(object sender, EventArgs e) {
new EventWaiter(TestFunc); // ←[D]
}
ライブラリの名前空間を「SimonPG.WaitCore」としてあるので、始めに[A]のようにインポートします。このライブラリの中で中心的なクラスはEventWaiterクラスです。このクラスを[D]のように引数に関数を指定してインスタンス化すると、その関数の中ではyield文を使ってイベントを待機できるようになります。イベントを待機するには、[C]のようにEventWaiterクラスの入ったwaiter変数からWait関数を呼び出し、引数に待機したいオブジェクトとイベント名を指定します。そして、Wait関数の戻り値をyield
returnの形で返します。
このコードの動作は次のようになります。まずフォームがロードされると、[D]のインスタンス化から内部でTestFunc関数が呼び出されて[A]に来ます。すると、「処理A」のコードがまず実行されて、[C]の行でbutton1のClickイベントが発生するまで待機します。Button1がクリックされると、待機が完了し「処理B」が実行されて、すべての処理が完了します。
[便利な場合の例]
コードの途中で待機できると、いろいろと便利な場合があります。例えば、Timerを使ってグラデーションしながら点滅表示する例を考えると、EventWaiterクラスを使ってコードの途中で待機すれば、次のように状態変数を使わずにスマートにコードを書けます。(コードの詳細はこちらに説明があります)
using SimonPG.WaitCore
IEnumerable TestFunc(EventWaiter waiter) {
while (true) {
for (var bright = 0; bright < 255; bright += 10) {
label1.BackColor = Color.FromArgb(
bright, bright, bright);
yield return waiter.Wait(timer1, "Tick");
}
for (var bright = 255; bright > 0; bright -= 10) {
label1.BackColor = Color.FromArgb(
bright, bright, bright);
yield return waiter.Wait(timer1, "Tick");
}
}
}
void Form_Load(object sender, EventArgs e) {
new EventWaiter(TestFunc);
}
[いろいろな待機]
このライブラリにはイベントの発生をただ待機するだけでなく、他にも複数のイベントをAND/OR/NOT結合して待機できたり、指定回数発生したイベントを待機できたり、いろいろな拡張機能があります。詳しくはこちらに説明があります。
[参考]
http://simonpg.web.fc2.com/Pages/labo/idea_p/20091001_UseYieldForWait/index.html
http://simonpg.web.fc2.com/Pages/labo/idea_p/20090213_StopCodeWithWaitKeyword/index.html
