spectre.console/src/Spectre.Console/Widgets/Progress/Progress.cs

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Spectre.Console.Internal;
using Spectre.Console.Rendering;

namespace Spectre.Console
{
    /// <summary>
    /// Represents a task list.
    /// </summary>
    public sealed class Progress
    {
        private readonly IAnsiConsole _console;

        /// <summary>
        /// Gets or sets a value indicating whether or not task list should auto refresh.
        /// Defaults to <c>true</c>.
        /// </summary>
        public bool AutoRefresh { get; set; } = true;

        /// <summary>
        /// Gets or sets a value indicating whether or not the task list should
        /// be cleared once it completes.
        /// Defaults to <c>false</c>.
        /// </summary>
        public bool AutoClear { get; set; }

        /// <summary>
        /// Gets or sets the refresh rate if <c>AutoRefresh</c> is enabled.
        /// Defaults to 10 times/second.
        /// </summary>
        public TimeSpan RefreshRate { get; set; } = TimeSpan.FromMilliseconds(100);

        internal List<ProgressColumn> Columns { get; }

        internal ProgressRenderer? FallbackRenderer { get; set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="Progress"/> class.
        /// </summary>
        /// <param name="console">The console to render to.</param>
        public Progress(IAnsiConsole console)
        {
            _console = console ?? throw new ArgumentNullException(nameof(console));

            // Initialize with default columns
            Columns = new List<ProgressColumn>
            {
                new TaskDescriptionColumn(),
                new ProgressBarColumn(),
                new PercentageColumn(),
            };
        }

        /// <summary>
        /// Starts the progress task list.
        /// </summary>
        /// <param name="action">The action to execute.</param>
        public void Start(Action<ProgressContext> action)
        {
            var task = StartAsync(ctx =>
            {
                action(ctx);
                return Task.CompletedTask;
            });

            task.GetAwaiter().GetResult();
        }

        /// <summary>
        /// Starts the progress task list and returns a result.
        /// </summary>
        /// <typeparam name="T">The result type.</typeparam>
        /// <param name="func">he action to execute.</param>
        /// <returns>The result.</returns>
        public T Start<T>(Func<ProgressContext, T> func)
        {
            var task = StartAsync(ctx => Task.FromResult(func(ctx)));
            return task.GetAwaiter().GetResult();
        }

        /// <summary>
        /// Starts the progress task list.
        /// </summary>
        /// <param name="action">The action to execute.</param>
        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
        public async Task StartAsync(Func<ProgressContext, Task> action)
        {
            if (action is null)
            {
                throw new ArgumentNullException(nameof(action));
            }

            _ = await StartAsync<object?>(async progressContext =>
            {
                await action(progressContext).ConfigureAwait(false);
                return default;
            }).ConfigureAwait(false);
        }

        /// <summary>
        /// Starts the progress task list and returns a result.
        /// </summary>
        /// <param name="action">The action to execute.</param>
        /// <typeparam name="T">The result type of task.</typeparam>
        /// <returns>A <see cref="Task{T}"/> representing the asynchronous operation.</returns>
        public async Task<T> StartAsync<T>(Func<ProgressContext, Task<T>> action)
        {
            if (action is null)
            {
                throw new ArgumentNullException(nameof(action));
            }

            var renderer = CreateRenderer();
            renderer.Started();

            T result;

            try
            {
                using (new RenderHookScope(_console, renderer))
                {
                    var context = new ProgressContext(_console, renderer);

                    if (AutoRefresh)
                    {
                        using (var thread = new ProgressRefreshThread(context, renderer.RefreshRate))
                        {
                            result = await action(context).ConfigureAwait(false);
                        }
                    }
                    else
                    {
                        result = await action(context).ConfigureAwait(false);
                    }

                    context.Refresh();
                }
            }
            finally
            {
                renderer.Completed(AutoClear);
            }

            return result;
        }

        private ProgressRenderer CreateRenderer()
        {
            var caps = _console.Capabilities;
            var interactive = caps.SupportsInteraction && caps.SupportsAnsi;

            if (interactive)
            {
                var columns = new List<ProgressColumn>(Columns);
                return new DefaultProgressRenderer(_console, columns, RefreshRate);
            }
            else
            {
                return FallbackRenderer ?? new FallbackProgressRenderer();
            }
        }
    }
}