You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
277 lines
12 KiB
277 lines
12 KiB
#nullable enable
|
|
using System;
|
|
using System.IO;
|
|
using System.Text;
|
|
using System.Linq;
|
|
using System.Collections.Generic;
|
|
using Mono.Cecil;
|
|
using System.Runtime.CompilerServices;
|
|
using System.Threading;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
#if NET3
|
|
using File = Net3_Proxy.File;
|
|
#endif
|
|
|
|
namespace IPA.Utilities
|
|
{
|
|
/// <summary>
|
|
/// A class providing static utility functions that in any other language would just *exist*.
|
|
/// </summary>
|
|
public static class Utils
|
|
{
|
|
/// <summary>
|
|
/// Converts a hex string to a byte array.
|
|
/// </summary>
|
|
/// <param name="hex">the hex stream</param>
|
|
/// <returns>the corresponding byte array</returns>
|
|
public static byte[] StringToByteArray(string hex)
|
|
{
|
|
if (hex is null)
|
|
throw new ArgumentNullException(nameof(hex));
|
|
int numberChars = hex.Length;
|
|
byte[] bytes = new byte[numberChars / 2];
|
|
for (int i = 0; i < numberChars; i += 2)
|
|
bytes[i / 2] = Convert.ToByte(hex.Substring(i, 2), 16);
|
|
return bytes;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Converts a byte array to a hex string.
|
|
/// </summary>
|
|
/// <param name="ba">the byte array</param>
|
|
/// <returns>the hex form of the array</returns>
|
|
public static string ByteArrayToString(byte[] ba)
|
|
{
|
|
if (ba is null)
|
|
throw new ArgumentNullException(nameof(ba));
|
|
var hex = new StringBuilder(ba.Length * 2);
|
|
foreach (byte b in ba)
|
|
_ = hex.AppendFormat("{0:x2}", b);
|
|
return hex.ToString();
|
|
}
|
|
|
|
// Copyright (c) 2008-2013 Hafthor Stefansson
|
|
// Distributed under the MIT/X11 software license
|
|
// Ref: http://www.opensource.org/licenses/mit-license.php.
|
|
// From: https://stackoverflow.com/a/8808245/3117125
|
|
/// <summary>
|
|
/// Uses unsafe code to compare 2 byte arrays quickly.
|
|
/// </summary>
|
|
/// <param name="a1">array 1</param>
|
|
/// <param name="a2">array 2</param>
|
|
/// <returns>whether or not they are byte-for-byte equal</returns>
|
|
public static unsafe bool UnsafeCompare(byte[] a1, byte[] a2)
|
|
{
|
|
if (a1 == a2) return true;
|
|
if (a1 == null || a2 == null || a1.Length != a2.Length)
|
|
return false;
|
|
fixed (byte* p1 = a1, p2 = a2)
|
|
{
|
|
byte* x1 = p1, x2 = p2;
|
|
int l = a1.Length;
|
|
for (int i = 0; i < l / 8; i++, x1 += 8, x2 += 8)
|
|
if (*(long*)x1 != *(long*)x2) return false;
|
|
if ((l & 4) != 0) { if (*(int*)x1 != *(int*)x2) return false; x1 += 4; x2 += 4; }
|
|
if ((l & 2) != 0) { if (*(short*)x1 != *(short*)x2) return false; x1 += 2; x2 += 2; }
|
|
if ((l & 1) != 0) if (*x1 != *x2) return false;
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a path relative to the provided folder.
|
|
/// </summary>
|
|
/// <param name="file">the file to relativize</param>
|
|
/// <param name="folder">the source folder</param>
|
|
/// <returns>a path to get from <paramref name="folder"/> to <paramref name="file"/></returns>
|
|
public static string GetRelativePath(string file, string folder)
|
|
{
|
|
if (file is null)
|
|
throw new ArgumentNullException(nameof(file));
|
|
if (folder is null)
|
|
throw new ArgumentNullException(nameof(folder));
|
|
|
|
var pathUri = new Uri(file);
|
|
// Folders must end in a slash
|
|
if (!folder.EndsWith(Path.DirectorySeparatorChar.ToString(), StringComparison.Ordinal))
|
|
{
|
|
folder += Path.DirectorySeparatorChar;
|
|
}
|
|
var folderUri = new Uri(folder);
|
|
return Uri.UnescapeDataString(folderUri.MakeRelativeUri(pathUri).ToString().Replace('/', Path.DirectorySeparatorChar));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Copies all files from <paramref name="source"/> to <paramref name="target"/>.
|
|
/// </summary>
|
|
/// <param name="source">the source directory</param>
|
|
/// <param name="target">the destination directory</param>
|
|
/// <param name="appendFileName">the filename of the file to append together</param>
|
|
/// <param name="onCopyException">a delegate called when there is an error copying. Return true to keep going.</param>
|
|
public static void CopyAll(DirectoryInfo source, DirectoryInfo target, string appendFileName = "",
|
|
Func<Exception, FileInfo, bool>? onCopyException = null)
|
|
{
|
|
if (source is null)
|
|
throw new ArgumentNullException(nameof(source));
|
|
if (target is null)
|
|
throw new ArgumentNullException(nameof(target));
|
|
|
|
if (source.FullName.ToUpperInvariant() == target.FullName.ToUpperInvariant())
|
|
{
|
|
return;
|
|
}
|
|
|
|
// Check if the target directory exists, if not, create it.
|
|
if (Directory.Exists(target.FullName) == false)
|
|
{
|
|
_ = Directory.CreateDirectory(target.FullName);
|
|
}
|
|
|
|
// Copy each file into it's new directory.
|
|
foreach (var fi in source.GetFiles())
|
|
{
|
|
try
|
|
{
|
|
if (fi.Name == appendFileName)
|
|
File.AppendAllLines(Path.Combine(target.ToString(), fi.Name), File.ReadAllLines(fi.FullName));
|
|
else
|
|
_ = fi.CopyTo(Path.Combine(target.ToString(), fi.Name), true);
|
|
}
|
|
catch (Exception e)
|
|
{
|
|
var keepOn = onCopyException?.Invoke(e, fi);
|
|
if (!keepOn.Unwrap())
|
|
throw;
|
|
}
|
|
}
|
|
|
|
// Copy each subdirectory using recursion.
|
|
foreach (var diSourceSubDir in source.GetDirectories())
|
|
{
|
|
var nextTargetSubDir = target.CreateSubdirectory(diSourceSubDir.Name);
|
|
CopyAll(diSourceSubDir, nextTargetSubDir, appendFileName, onCopyException);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Whether you can safely use <see cref="DateTime.Now"/> without Mono throwing a fit.
|
|
/// </summary>
|
|
/// <value><see langword="true"/> if you can use <see cref="DateTime.Now"/> safely, <see langword="false"/> otherwise</value>
|
|
public static bool CanUseDateTimeNowSafely { get; private set; } = true;
|
|
private static bool DateTimeSafetyUnknown = true;
|
|
|
|
/// <summary>
|
|
/// Returns <see cref="DateTime.Now"/> if supported, otherwise <see cref="DateTime.UtcNow"/>.
|
|
/// </summary>
|
|
/// <returns>the current <see cref="DateTime"/> if supported, otherwise some indeterminant increasing value.</returns>
|
|
public static DateTime CurrentTime()
|
|
{
|
|
if (DateTimeSafetyUnknown)
|
|
{
|
|
var time = DateTime.MinValue;
|
|
try
|
|
{
|
|
time = DateTime.Now;
|
|
}
|
|
catch (TimeZoneNotFoundException)
|
|
{ // Mono did a fucky wucky and we need to avoid this call
|
|
CanUseDateTimeNowSafely = false;
|
|
}
|
|
DateTimeSafetyUnknown = false;
|
|
return time;
|
|
}
|
|
else
|
|
{
|
|
if (CanUseDateTimeNowSafely) return DateTime.Now;
|
|
else return DateTime.UtcNow; // return MinValue as a fallback
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Compares a pair of <see cref="SemVer.Version"/>s ignoring both the prerelease and build fields.
|
|
/// </summary>
|
|
/// <param name="l">the left value</param>
|
|
/// <param name="r">the right value</param>
|
|
/// <returns>< 0 if l is less than r, 0 if they are equal in the numeric portion, or > 0 if l is greater than r</returns>
|
|
public static int VersionCompareNoPrerelease(SemVer.Version l, SemVer.Version r)
|
|
{
|
|
if (l is null) throw new ArgumentNullException(nameof(l));
|
|
if (r is null) throw new ArgumentNullException(nameof(r));
|
|
|
|
var cmpVal = l.Major - r.Major;
|
|
if (cmpVal != 0) return cmpVal;
|
|
cmpVal = l.Minor - r.Minor;
|
|
if (cmpVal != 0) return cmpVal;
|
|
cmpVal = l.Patch - r.Patch;
|
|
return cmpVal;
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
/// An object used to manage scope guards.
|
|
/// </summary>
|
|
/// <example>
|
|
/// <code>
|
|
/// using var _ = new Utils.ScopeGuardObject(() => RunOnScopeExit(value));
|
|
/// </code>
|
|
/// </example>
|
|
/// <seealso cref="ScopeGuard(Action)"/>
|
|
[SuppressMessage("Design", "CA1034:Nested types should not be visible",
|
|
Justification = "This type needs to be public to avoid allocations")]
|
|
[SuppressMessage("Performance", "CA1815:Override equals and operator equals on value types",
|
|
Justification = "This type is never supposed to be compared")]
|
|
public struct ScopeGuardObject : IDisposable
|
|
{
|
|
private readonly Action action;
|
|
/// <summary>
|
|
/// Creates a new scope guard that will invoke <paramref name="action"/> when disposed.
|
|
/// </summary>
|
|
/// <param name="action">the action to run on dispose</param>
|
|
public ScopeGuardObject(Action action)
|
|
=> this.action = action;
|
|
void IDisposable.Dispose()
|
|
=> action?.Invoke();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a scope guard for a given <see cref="Action"/>.
|
|
/// </summary>
|
|
/// <param name="action">the <see cref="Action"/> to run on dispose</param>
|
|
/// <returns>a <see cref="ScopeGuardObject"/> that will run <paramref name="action"/> on disposal</returns>
|
|
/// <example>
|
|
/// <code>
|
|
/// using var _ = Utils.ScopeGuard(() => RunOnScopeExit(value));
|
|
/// </code>
|
|
/// </example>
|
|
public static ScopeGuardObject ScopeGuard(Action action)
|
|
=> new(action);
|
|
|
|
/// <summary>
|
|
/// Deconstructs a <see cref="KeyValuePair{TKey, TValue}"/> as its key and value.
|
|
/// </summary>
|
|
/// <typeparam name="TKey">The type of the key.</typeparam>
|
|
/// <typeparam name="TValue">The type of the value.</typeparam>
|
|
/// <param name="kvp">The <see cref="KeyValuePair{TKey, TValue}"/> to deconstruct.</param>
|
|
/// <param name="key">The key in <paramref name="kvp"/>.</param>
|
|
/// <param name="value">The value in <paramref name="kvp"/>.</param>
|
|
public static void Deconstruct<TKey, TValue>(this KeyValuePair<TKey, TValue> kvp, out TKey key, out TValue value)
|
|
=> (key, value) = (kvp.Key, kvp.Value);
|
|
|
|
internal static bool HasInterface(this TypeDefinition? type, string interfaceFullName)
|
|
{
|
|
return (type?.Interfaces?.Any(i => i.InterfaceType.FullName == interfaceFullName) ?? false)
|
|
|| (type?.Interfaces?.Any(t => HasInterface(t?.InterfaceType?.Resolve(), interfaceFullName)) ?? false);
|
|
}
|
|
|
|
#if NET4
|
|
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
|
internal static IEnumerable<string> StrJP(this IEnumerable<string> a) => a;
|
|
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
|
internal static IEnumerable<string> StrJP<T>(this IEnumerable<T> a) => a.Select(o => $"{o}" /* safer than .ToString() */);
|
|
#endif
|
|
#if NET3
|
|
internal static string[] StrJP(this IEnumerable<string> a) => a.ToArray();
|
|
internal static string[] StrJP<T>(this IEnumerable<T> a) => a.Select(o => $"{o}" /* safer than .ToString() */).ToArray();
|
|
#endif
|
|
}
|
|
}
|