Vanara/Core/ByteSizeFormatter.cs

73 lines
3.4 KiB
C#

using System.Text.RegularExpressions;
namespace Vanara;
/// <summary>
/// A custom formatter for byte sizes (things like files, network bandwidth, etc.) that will automatically determine the best abbreviation.
/// </summary>
public class ByteSizeFormatter : Formatter
{
/// <summary>A static instance of <see cref="ByteSizeFormatter"/>.</summary>
public static readonly ByteSizeFormatter Instance = new();
private static readonly string[] suffixes = { " B", " KB", " MB", " GB", " TB", " PB", " EB" };
/// <summary>
/// Converts the string representation of a byte size to its 64-bit signed integer equivalent. A return value indicates whether the
/// conversion succeeded.
/// </summary>
/// <param name="input">A string containing a byte size to convert.</param>
/// <param name="bytes">
/// When this method returns, contains the 64-bit signed integer value equivalent of the value contained in <paramref name="input"/>, if
/// the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="input"/> parameter is null or
/// Empty, or is not of the correct format. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.
/// </param>
/// <returns><see langword="true"/> if <paramref name="input"/> was converted successfully; otherwise, <see langword="false"/>.</returns>
/// <exception cref="InvalidOperationException"></exception>
public static bool TryParse(string input, out long bytes)
{
const string expr = @"^\s*(?<num>\d+(?:\.\d+)?)\s*(?<mod>[kKmMgGtTpPeEyY]?[bB])?\s*$";
var match = Regex.Match(input, expr);
bytes = 0;
if (!match.Success) return false;
long mult = match.Groups["mod"].Value.ToUpper() switch
{
"B" or "" => 1,
"KB" => 1024,
"MB" => (long)Math.Pow(1024, 2),
"GB" => (long)Math.Pow(1024, 3),
"TB" => (long)Math.Pow(1024, 4),
"PB" => (long)Math.Pow(1024, 5),
"EB" => (long)Math.Pow(1024, 6),
"YB" => (long)Math.Pow(1024, 7),
_ => throw new InvalidOperationException(),
};
bytes = (long)Math.Round(float.Parse(match.Groups["num"].Value) * mult);
return true;
}
/// <summary>
/// Converts the value of a specified object to an equivalent string representation using specified format and culture-specific
/// formatting information.
/// </summary>
/// <param name="format">A format string containing formatting specifications.</param>
/// <param name="arg">An object to format.</param>
/// <param name="formatProvider">An object that supplies format information about the current instance.</param>
/// <returns>
/// The string representation of the value of <paramref name="arg"/>, formatted as specified by <paramref name="format"/> and <paramref name="formatProvider"/>.
/// </returns>
public override string Format(string? format, object? arg, IFormatProvider? formatProvider)
{
long bytes;
try { bytes = Convert.ToInt64(arg); }
catch { return HandleOtherFormats(format, arg); }
if (bytes == 0) return "0" + suffixes[0];
var m = format is not null ? Regex.Match(format, @"^[B|b](?<prec>\d+)?$") : null;
if (m is null || !m.Success) return HandleOtherFormats(format, arg);
var prec = m.Groups["prec"].Success ? byte.Parse(m.Groups["prec"].Value) : 0;
var place = Convert.ToInt32(Math.Floor(Math.Log(bytes, 1024)));
if (place >= suffixes.Length) place = suffixes.Length - 1;
var num = Math.Round(bytes / Math.Pow(1024, place), 1);
return $"{num.ToString("F" + prec).TrimEnd('0')}{suffixes[place]}";
}
}