|
| 1 | +using System; |
| 2 | +using System.Threading; |
| 3 | +using System.Threading.Tasks; |
| 4 | + |
| 5 | +namespace FolderDiffIL4DotNet.Utils |
| 6 | +{ |
| 7 | + /// <summary> |
| 8 | + /// シンプルなコンソールスピナー。指定したラベルと共に一定間隔で回転する文字を表示します。 |
| 9 | + /// 無音区間でもユーザーに処理継続中であることを示す用途を想定しています。 |
| 10 | + /// </summary> |
| 11 | + public sealed class ConsoleSpinner : IDisposable |
| 12 | + { |
| 13 | + #region private constants |
| 14 | + /// <summary> |
| 15 | + /// 既定のフレーム更新間隔（ミリ秒）。 |
| 16 | + /// </summary> |
| 17 | + private const int DEFAULT_INTERVAL_MILLISECONDS = 120; |
| 18 | + #endregion |
| 19 | + |
| 20 | + #region private readonly member variables |
| 21 | + /// <summary> |
| 22 | + /// デフォルトのスピナーフレーム。 |
| 23 | + /// </summary> |
| 24 | + private static readonly char[] DefaultFrames = ['|', '/', '-', '\\']; |
| 25 | + |
| 26 | + /// <summary> |
| 27 | + /// スピナー前に表示するラベル。 |
| 28 | + /// </summary> |
| 29 | + private readonly string _label; |
| 30 | + |
| 31 | + /// <summary> |
| 32 | + /// スピナーに使用するフレーム集合。 |
| 33 | + /// </summary> |
| 34 | + private readonly char[] _frames; |
| 35 | + |
| 36 | + /// <summary> |
| 37 | + /// フレーム更新間隔。 |
| 38 | + /// </summary> |
| 39 | + private readonly TimeSpan _interval; |
| 40 | + |
| 41 | + /// <summary> |
| 42 | + /// アニメーション停止用のキャンセルトークン。 |
| 43 | + /// </summary> |
| 44 | + private readonly CancellationTokenSource _cts = new(); |
| 45 | + |
| 46 | + /// <summary> |
| 47 | + /// スピナーアニメーションを実行するタスク。 |
| 48 | + /// </summary> |
| 49 | + private readonly Task _animationTask; |
| 50 | + #endregion |
| 51 | + |
| 52 | + #region private member variables |
| 53 | + /// <summary> |
| 54 | + /// 現在表示しているフレームインデックス。 |
| 55 | + /// </summary> |
| 56 | + private int _frameIndex; |
| 57 | + |
| 58 | + /// <summary> |
| 59 | + /// 直近に描画したコンテンツの文字数（消去用）。 |
| 60 | + /// </summary> |
| 61 | + private int _lastRenderLength; |
| 62 | + |
| 63 | + /// <summary> |
| 64 | + /// 停止済みかどうか。 |
| 65 | + /// </summary> |
| 66 | + private bool _isStopped; |
| 67 | + #endregion |
| 68 | + |
| 69 | + /// <summary> |
| 70 | + /// スピナーを開始します。 |
| 71 | + /// </summary> |
| 72 | + /// <param name="label">スピナーの前に表示するラベル。</param> |
| 73 | + /// <param name="intervalMilliseconds">フレーム更新間隔（ミリ秒）。</param> |
| 74 | + /// <param name="frames">スピナーで使用するフレーム文字（省略時は | / - \）。</param> |
| 75 | + public ConsoleSpinner(string label, int intervalMilliseconds = DEFAULT_INTERVAL_MILLISECONDS, char[] frames = null) |
| 76 | + { |
| 77 | + _label = label; |
| 78 | + _frames = frames ?? DefaultFrames; |
| 79 | + _interval = TimeSpan.FromMilliseconds(intervalMilliseconds); |
| 80 | + _animationTask = Task.Run(SpinAsync); |
| 81 | + } |
| 82 | + |
| 83 | + /// <summary> |
| 84 | + /// 指定間隔でスピナーフレームを更新しつつコンソールへ描画する内部ループ。 |
| 85 | + /// </summary> |
| 86 | + private async Task SpinAsync() |
| 87 | + { |
| 88 | + while (!_cts.IsCancellationRequested) |
| 89 | + { |
| 90 | + var prefix = string.IsNullOrEmpty(_label) ? string.Empty : _label + " "; |
| 91 | + var frame = _frames[_frameIndex++ % _frames.Length]; |
| 92 | + var text = $"{prefix}{frame}"; |
| 93 | + _lastRenderLength = text.Length; |
| 94 | + Console.Write($"\r{text}"); |
| 95 | + Console.Out.Flush(); |
| 96 | + try |
| 97 | + { |
| 98 | + await Task.Delay(_interval, _cts.Token); |
| 99 | + } |
| 100 | + catch (TaskCanceledException) |
| 101 | + { |
| 102 | + break; |
| 103 | + } |
| 104 | + } |
| 105 | + } |
| 106 | + |
| 107 | + /// <summary> |
| 108 | + /// 直近で描画したスピナー行を消去します。 |
| 109 | + /// </summary> |
| 110 | + private void ClearLine() |
| 111 | + { |
| 112 | + if (_lastRenderLength <= 0) |
| 113 | + { |
| 114 | + return; |
| 115 | + } |
| 116 | + Console.Write("\r" + new string(' ', _lastRenderLength) + "\r"); |
| 117 | + Console.Out.Flush(); |
| 118 | + } |
| 119 | + |
| 120 | + /// <summary> |
| 121 | + /// スピナー描画ループを停止し、残っているアニメーション行をクリアします。 |
| 122 | + /// </summary> |
| 123 | + private void StopInternal() |
| 124 | + { |
| 125 | + if (_isStopped) |
| 126 | + { |
| 127 | + return; |
| 128 | + } |
| 129 | + _isStopped = true; |
| 130 | + _cts.Cancel(); |
| 131 | + try |
| 132 | + { |
| 133 | + _animationTask.Wait(); |
| 134 | + } |
| 135 | + catch (AggregateException ex) when (ex.InnerException is TaskCanceledException) |
| 136 | + { |
| 137 | + // ignore cancellation |
| 138 | + } |
| 139 | + ClearLine(); |
| 140 | + } |
| 141 | + |
| 142 | + /// <summary> |
| 143 | + /// スピナーを停止し、任意の完了メッセージを出力します。 |
| 144 | + /// </summary> |
| 145 | + /// <param name="completionMessage">停止後に出力するメッセージ。</param> |
| 146 | + public void Complete(string completionMessage = null) |
| 147 | + { |
| 148 | + StopInternal(); |
| 149 | + if (!string.IsNullOrEmpty(completionMessage)) |
| 150 | + { |
| 151 | + Console.WriteLine(completionMessage); |
| 152 | + } |
| 153 | + } |
| 154 | + |
| 155 | + /// <summary> |
| 156 | + /// スピナーを停止します。 |
| 157 | + /// </summary> |
| 158 | + public void Dispose() |
| 159 | + { |
| 160 | + StopInternal(); |
| 161 | + _cts.Dispose(); |
| 162 | + } |
| 163 | + } |
| 164 | +} |
0 commit comments