// OpenTween - Client of Twitter
// Copyright (c) 2015 kim_upsilon (@kim_upsilon)
// All rights reserved.
//
// This file is part of OpenTween.
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General public License as published by the Free
// Software Foundation; either version 3 of the License, or (at your option)
// any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General public License
// for more details.
//
// You should have received a copy of the GNU General public License along
// with this program. If not, see , or write to
// the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
// Boston, MA 02110-1301, USA.
#nullable enable
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;
namespace OpenTween
{
///
/// タスクが待機中であることを表示するダイアログ
///
///
/// 一定時間 (Timeout プロパティで指定する) 以上経ってもタスクが完了しない場合にダイアログを表示します。
/// EnableCancellation メソッドを使用することでキャンセル機能を提供することも可能です。
///
public partial class WaitingDialog : OTBaseForm
{
private readonly Lazy cancellationTokenSource;
private bool cancellationEnabled = false;
///
/// ダイアログを表示せずに待機する最短の待ち時間 (デフォルト0.5秒)
///
public TimeSpan Timeout { get; set; }
///
/// ダイアログに表示するメッセージ
///
public string Message
{
get => this.labelMessage.Text;
set => this.labelMessage.Text = value;
}
public WaitingDialog()
{
this.InitializeComponent();
this.cancellationTokenSource = new Lazy();
this.Timeout = TimeSpan.FromMilliseconds(500);
}
public WaitingDialog(string message)
: this()
{
this.Message = message;
}
///
/// キャンセル機能を有効にし、キャンセルを通知するための CancellationToken を返します
///
public CancellationToken EnableCancellation()
{
this.cancellationEnabled = true;
this.ControlBox = true;
var cts = this.cancellationTokenSource.Value;
return cts.Token;
}
public Task WaitForAsync(Task task)
=> this.WaitForAsync(this.ConvertTaskWithValue(task));
public Task WaitForAsync(IWin32Window? owner, Task task)
=> this.WaitForAsync(owner, this.ConvertTaskWithValue(task));
public Task WaitForAsync(Task task)
=> this.WaitForAsync(null, task);
///
/// タスクを待機し、状況に応じて待機中ダイアログを表示します
///
/// ダイアログのオーナー
/// 待機するタスク
public Task WaitForAsync(IWin32Window? owner, Task task)
{
return Task.Run(async () =>
{
// 指定された秒数以内で完了すればダイアログは表示しない
var timeout = Task.Delay(this.Timeout);
if (await Task.WhenAny(task, timeout) != timeout)
return await task;
var dialogTask = this.InvokeAsync(() => this.ShowDialog(owner));
// キャンセルされずにタスクが先に完了したらダイアログを閉じる
if (await Task.WhenAny(task, dialogTask) != dialogTask)
await this.InvokeAsync(() => this.DialogResult = DialogResult.OK);
return await task;
});
}
/// Task を Task<T> に変換したいだけ
private async Task ConvertTaskWithValue(Task task)
{
await task.ConfigureAwait(false);
return 0;
}
private void ProgressDialog_FormClosing(object sender, FormClosingEventArgs e)
{
if (this.cancellationEnabled)
{
if (e.CloseReason == CloseReason.UserClosing)
{
var cts = this.cancellationTokenSource.Value;
cts.Cancel();
}
}
}
private void ProgressDialog_KeyDown(object sender, KeyEventArgs e)
{
if (this.cancellationEnabled)
{
if (e.KeyCode == Keys.Escape)
{
var cts = this.cancellationTokenSource.Value;
cts.Cancel();
this.DialogResult = DialogResult.Cancel;
}
}
}
}
}