Merge pull request #517 from SteamRE/progress
Use ansi escape code to indicate download progress in taskbarpull/520/head
Pavel Djundik
1 year ago
committed by
GitHub
commit
9a3f27ddec
@ -0,0 +1,51 @@
|
||||
using System;
|
||||
using Spectre.Console;
|
||||
|
||||
namespace DepotDownloader;
|
||||
|
||||
static class Ansi
|
||||
{
|
||||
// https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC
|
||||
// https://learn.microsoft.com/en-us/windows/terminal/tutorials/progress-bar-sequences
|
||||
public enum ProgressState
|
||||
{
|
||||
Hidden = 0,
|
||||
Default = 1,
|
||||
Error = 2,
|
||||
Indeterminate = 3,
|
||||
Warning = 4,
|
||||
}
|
||||
|
||||
const char ESC = (char)0x1B;
|
||||
const char BEL = (char)0x07;
|
||||
|
||||
private static bool useProgress;
|
||||
|
||||
public static void Init()
|
||||
{
|
||||
if (Console.IsInputRedirected || Console.IsOutputRedirected)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
var (supportsAnsi, legacyConsole) = AnsiDetector.Detect(stdError: false, upgrade: true);
|
||||
|
||||
useProgress = supportsAnsi && !legacyConsole;
|
||||
}
|
||||
|
||||
public static void Progress(ulong downloaded, ulong total)
|
||||
{
|
||||
var progress = (byte)MathF.Round(downloaded / (float)total * 100.0f);
|
||||
Progress(ProgressState.Default, progress);
|
||||
}
|
||||
|
||||
public static void Progress(ProgressState state, byte progress = 0)
|
||||
{
|
||||
if (!useProgress)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
Console.Write($"{ESC}]9;4;{(byte)state};{progress}{BEL}");
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,134 @@
|
||||
// Copied from https://github.com/spectreconsole/spectre.console/blob/d79e6adc5f8e637fb35c88f987023ffda6707243/src/Spectre.Console/Internal/Backends/Ansi/AnsiDetector.cs
|
||||
// MIT License - Copyright(c) 2020 Patrik Svensson, Phil Scott, Nils Andresen
|
||||
// which is partially based on https://github.com/keqingrong/supports-ansi/blob/master/index.js
|
||||
// <auto-generated/>
|
||||
|
||||
using System;
|
||||
using System.Linq;
|
||||
using System.Runtime.InteropServices;
|
||||
using System.Text.RegularExpressions;
|
||||
|
||||
namespace Spectre.Console;
|
||||
|
||||
internal static class AnsiDetector
|
||||
{
|
||||
private static readonly Regex[] _regexes =
|
||||
[
|
||||
new("^xterm"), // xterm, PuTTY, Mintty
|
||||
new("^rxvt"), // RXVT
|
||||
new("^eterm"), // Eterm
|
||||
new("^screen"), // GNU screen, tmux
|
||||
new("tmux"), // tmux
|
||||
new("^vt100"), // DEC VT series
|
||||
new("^vt102"), // DEC VT series
|
||||
new("^vt220"), // DEC VT series
|
||||
new("^vt320"), // DEC VT series
|
||||
new("ansi"), // ANSI
|
||||
new("scoansi"), // SCO ANSI
|
||||
new("cygwin"), // Cygwin, MinGW
|
||||
new("linux"), // Linux console
|
||||
new("konsole"), // Konsole
|
||||
new("bvterm"), // Bitvise SSH Client
|
||||
new("^st-256color"), // Suckless Simple Terminal, st
|
||||
new("alacritty"), // Alacritty
|
||||
];
|
||||
|
||||
public static (bool SupportsAnsi, bool LegacyConsole) Detect(bool stdError, bool upgrade)
|
||||
{
|
||||
// Running on Windows?
|
||||
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
|
||||
{
|
||||
// Running under ConEmu?
|
||||
var conEmu = Environment.GetEnvironmentVariable("ConEmuANSI");
|
||||
if (!string.IsNullOrEmpty(conEmu) && conEmu.Equals("On", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
return (true, false);
|
||||
}
|
||||
|
||||
var supportsAnsi = Windows.SupportsAnsi(upgrade, stdError, out var legacyConsole);
|
||||
return (supportsAnsi, legacyConsole);
|
||||
}
|
||||
|
||||
return DetectFromTerm();
|
||||
}
|
||||
|
||||
private static (bool SupportsAnsi, bool LegacyConsole) DetectFromTerm()
|
||||
{
|
||||
// Check if the terminal is of type ANSI/VT100/xterm compatible.
|
||||
var term = Environment.GetEnvironmentVariable("TERM");
|
||||
if (!string.IsNullOrWhiteSpace(term))
|
||||
{
|
||||
if (_regexes.Any(regex => regex.IsMatch(term)))
|
||||
{
|
||||
return (true, false);
|
||||
}
|
||||
}
|
||||
|
||||
return (false, true);
|
||||
}
|
||||
|
||||
private static class Windows
|
||||
{
|
||||
private const int STD_OUTPUT_HANDLE = -11;
|
||||
private const int STD_ERROR_HANDLE = -12;
|
||||
private const uint ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x0004;
|
||||
private const uint DISABLE_NEWLINE_AUTO_RETURN = 0x0008;
|
||||
|
||||
[DllImport("kernel32.dll")]
|
||||
private static extern bool GetConsoleMode(IntPtr hConsoleHandle, out uint lpMode);
|
||||
|
||||
[DllImport("kernel32.dll")]
|
||||
private static extern bool SetConsoleMode(IntPtr hConsoleHandle, uint dwMode);
|
||||
|
||||
[DllImport("kernel32.dll", SetLastError = true)]
|
||||
private static extern IntPtr GetStdHandle(int nStdHandle);
|
||||
|
||||
[DllImport("kernel32.dll")]
|
||||
public static extern uint GetLastError();
|
||||
|
||||
public static bool SupportsAnsi(bool upgrade, bool stdError, out bool isLegacy)
|
||||
{
|
||||
isLegacy = false;
|
||||
|
||||
try
|
||||
{
|
||||
var @out = GetStdHandle(stdError ? STD_ERROR_HANDLE : STD_OUTPUT_HANDLE);
|
||||
if (!GetConsoleMode(@out, out var mode))
|
||||
{
|
||||
// Could not get console mode, try TERM (set in cygwin, WSL-Shell).
|
||||
var (ansiFromTerm, legacyFromTerm) = DetectFromTerm();
|
||||
|
||||
isLegacy = ansiFromTerm ? legacyFromTerm : isLegacy;
|
||||
return ansiFromTerm;
|
||||
}
|
||||
|
||||
if ((mode & ENABLE_VIRTUAL_TERMINAL_PROCESSING) == 0)
|
||||
{
|
||||
isLegacy = true;
|
||||
|
||||
if (!upgrade)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
// Try enable ANSI support.
|
||||
mode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING | DISABLE_NEWLINE_AUTO_RETURN;
|
||||
if (!SetConsoleMode(@out, mode))
|
||||
{
|
||||
// Enabling failed.
|
||||
return false;
|
||||
}
|
||||
|
||||
isLegacy = false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
catch
|
||||
{
|
||||
// All we know here is that we don't support ANSI.
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue