[WIP] Meg max file size 2gb

.gitignore

@@ -400,3 +400,4 @@ Thumbs.db
 Desktop.ini
 .DS_Store
 /testEnvironments.json
+/.idea

PG.Commons/PG.Commons.Test/DataTypes/CrcBasedEqualityComparerTest.cs

@@ -50,7 +50,7 @@ public override bool Equals(object? obj)
     {
         if (ReferenceEquals(null, obj)) return false;
         if (ReferenceEquals(this, obj)) return true;
-        if (obj.GetType() != this.GetType()) return false;
+        if (obj.GetType() != GetType()) return false;
         return Equals((HasCrcClass)obj);
     }
 
@@ -71,7 +71,7 @@ protected override HasCrcClass CreateT(int crc)
     public void GetHashCode_NullArgs_Throws()
     {
         var comparer = CrcBasedEqualityComparer<HasCrcClass>.Instance;
-        Assert.Throws<ArgumentNullException>(() => comparer.GetHashCode(null!));
+        Assert.Equal(0, comparer.GetHashCode(null));
     }
 }
 

PG.Commons/PG.Commons.Test/Hashing/Crc32HashingProviderTest.cs

@@ -27,13 +27,13 @@ public unsafe void HashData(byte[] inputData, uint expected)
 
         Assert.Equal(sizeof(Crc32), bytesWritten);
         var expectedBytes = BitConverter.GetBytes(expected);
-        Assert.Equal(expectedBytes, destination.Slice(0, bytesWritten).ToArray());
+        Assert.Equal(expectedBytes.AsSpan(), destination[..bytesWritten]);
 
 
         bytesWritten = new Crc32HashingProvider().HashData(new MemoryStream(inputData), destination);
         Assert.Equal(sizeof(Crc32), bytesWritten);
         expectedBytes = BitConverter.GetBytes(expected);
-        Assert.Equal(expectedBytes, destination.Slice(0, bytesWritten).ToArray());
+        Assert.Equal(expectedBytes.AsSpan(), destination[..bytesWritten]);
     }
 
     [Theory]
@@ -44,10 +44,11 @@ public unsafe void HashData(byte[] inputData, uint expected)
     public async Task HashDataAsync(byte[] inputData, uint expected)
     {
         var destination = new byte[20];
-        var bytesWritten = await new Crc32HashingProvider().HashDataAsync(new MemoryStream(inputData), destination);
+        var bytesWritten = await new Crc32HashingProvider()
+            .HashDataAsync(new MemoryStream(inputData), destination, TestContext.Current.CancellationToken);
 
         Assert.Equal(4, bytesWritten);
         var expectedBytes = BitConverter.GetBytes(expected);
-        Assert.Equal(expectedBytes, destination.AsSpan().Slice(0, bytesWritten).ToArray());
+        Assert.Equal(expectedBytes.AsSpan(), destination.AsSpan()[..bytesWritten]);
     }
 }

PG.Commons/PG.Commons.Test/PG.Commons.Test.csproj

@@ -14,7 +14,7 @@
 		<PackageReference Include="GitHubActionsTestLogger" Version="3.0.1" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.0.1" />
 		<PackageReference Include="xunit.v3.mtp-v2" Version="3.2.2" />
-		<PackageReference Include="Microsoft.Testing.Platform" Version="2.0.2" />
+		<PackageReference Include="Microsoft.Testing.Platform" Version="2.1.0" />
 		<PackageReference Include="IsExternalInit" Version="1.0.3">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

PG.Commons/PG.Commons.Test/Utilities/StreamExtensionsTest.cs

@@ -1,7 +1,7 @@
-using System.IO;
-using System;
-using PG.Commons.Utilities;
+using PG.Commons.Utilities;
 using PG.Testing;
+using System;
+using System.IO;
 using Testably.Abstractions.Testing;
 using Xunit;
 
@@ -12,39 +12,70 @@ public class StreamExtensionsTest
     [Fact]
     public void GetFilePath_FileStream()
     {
-        var expectedPath = "testfile.txt";
+        const string expectedPath = "testfile.txt";
         using var fileStream = new FileStream(expectedPath, FileMode.Create, FileAccess.Write, FileShare.None, 1024, FileOptions.DeleteOnClose);
+        Assert.True(fileStream.TryGetFilePath(out var path1));
+        Assert.True(fileStream.TryGetFilePath(out var path2, out var isMeg));
+        Assert.False(isMeg);
+        Assert.Equal(Path.GetFullPath(expectedPath), path1);
+        Assert.Equal(Path.GetFullPath(expectedPath), path2);
+        Assert.Equal(Path.GetFullPath(expectedPath), fileStream.TryGetFilePath());
         Assert.Equal(Path.GetFullPath(expectedPath), fileStream.GetFilePath());
-        Assert.Equal(Path.GetFullPath(expectedPath), fileStream.GetFilePath(out var isMeg));
+        Assert.Equal(Path.GetFullPath(expectedPath), fileStream.GetFilePath(out isMeg));
         Assert.False(isMeg);
     }
 
     [Fact]
     public void GetFilePath_FileSystemStream()
     {
+        const string expectedPath = "filesystemfile.txt";
         var fs = new MockFileSystem();
-        var expectedPath = "filesystemfile.txt";
         var fileSystemStream = fs.FileStream.New(expectedPath, FileMode.Create);
+
+        Assert.True(fileSystemStream.TryGetFilePath(out var path1));
+        Assert.True(fileSystemStream.TryGetFilePath(out var path2, out var isMeg));
+        Assert.False(isMeg);
+        Assert.Equal(fs.Path.GetFullPath(expectedPath), path1);
+        Assert.Equal(fs.Path.GetFullPath(expectedPath), path2);
+        Assert.Equal(fs.Path.GetFullPath(expectedPath), fileSystemStream.TryGetFilePath());
         Assert.Equal(fs.Path.GetFullPath(expectedPath), fileSystemStream.GetFilePath());
-        Assert.Equal(fs.Path.GetFullPath(expectedPath), fileSystemStream.GetFilePath(out var isMeg));
+        Assert.Equal(fs.Path.GetFullPath(expectedPath), fileSystemStream.GetFilePath(out isMeg));
         Assert.False(isMeg);
     }
 
     [Fact]
     public void GetFilePath_IMegFileDataStream()
     {
-        var expectedPath = "megfiledatafile.txt";
-        var megFileDataStream = new TestMegDataStream("megfiledatafile.txt", Stream.Null);
+        const string expectedPath = "megfiledatafile.txt";
+        var megFileDataStream = new TestMegDataStream(expectedPath, Stream.Null);
 
+        Assert.True(megFileDataStream.TryGetFilePath(out var path1));
+        Assert.True(megFileDataStream.TryGetFilePath(out var path2, out var isMeg));
+        Assert.True(isMeg);
+        Assert.Equal(expectedPath, path1);
+        Assert.Equal(expectedPath, path2);
+        Assert.Equal(expectedPath, megFileDataStream.TryGetFilePath());
         Assert.Equal(expectedPath, megFileDataStream.GetFilePath());
-        Assert.Equal(expectedPath, megFileDataStream.GetFilePath(out var isMeg));
+        Assert.Equal(expectedPath, megFileDataStream.GetFilePath(out isMeg));
         Assert.True(isMeg);
     }
 
     [Fact]
     public void GetFilePath_StreamWithoutPath_ThrowsInvalidOperationException()
     {
         var memoryStream = new MemoryStream();
+
+        var isMeg = false;
+
         Assert.Throws<InvalidOperationException>(memoryStream.GetFilePath);
+        Assert.Throws<InvalidOperationException>(() => memoryStream.GetFilePath(out isMeg));
+        Assert.False(isMeg);
+
+        Assert.Null(memoryStream.TryGetFilePath());
+        Assert.False(memoryStream.TryGetFilePath(out var path1));
+        Assert.False(memoryStream.TryGetFilePath(out var path2, out isMeg));
+        Assert.Null(path1);
+        Assert.Null(path2);
+        Assert.False(isMeg);
     }
 }

PG.Commons/PG.Commons/Data/CrcBasedEqualityComparer.cs

@@ -1,7 +1,6 @@
 // Copyright (c) Alamo Engine Tools and contributors. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for details.
 
-using System;
 using System.Collections.Generic;
 
 namespace PG.Commons.Data;
@@ -72,9 +71,8 @@ public bool Equals(T? x, T? y)
     /// <returns>
     /// A hash code for the specified object, derived from its <see cref="IHasCrc32.Crc32"/> value.
     /// </returns>
-    /// <exception cref="ArgumentNullException"><paramref name="obj"/> is <see langword="null"/>.</exception>
-    public int GetHashCode(T obj)
+    public int GetHashCode(T? obj)
     {
-        return obj is null ? throw new ArgumentNullException(nameof(obj)) : obj.Crc32.GetHashCode();
+        return obj?.Crc32.GetHashCode() ?? 0;
     }
 }

PG.Commons/PG.Commons/Utilities/PGFileNameUtilities.cs

@@ -49,9 +49,7 @@ private static bool ContainsInvalidPGChars(ReadOnlySpan<char> value)
         {
             if (IsInvalidFileCharacter(t))
                 return true;
-
         }
-
         return false;
     }
 

PG.Commons/PG.Commons/Utilities/StreamExtensions.cs

@@ -3,6 +3,7 @@
 
 using PG.Commons.Data;
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.IO.Abstractions;
 
@@ -21,7 +22,7 @@ public static class StreamExtensions
     /// <exception cref="InvalidOperationException"><paramref name="stream"/> does not have path information.</exception>
     public static string GetFilePath(this Stream stream)
     {
-        return GetFilePath(stream, out _);
+        return stream.GetFilePath(out _);
     }
 
     /// <summary>
@@ -32,18 +33,73 @@ public static string GetFilePath(this Stream stream)
     /// <returns>The file path of the opened file.</returns>
     /// <exception cref="InvalidOperationException"><paramref name="stream"/> does not have path information.</exception>
     public static string GetFilePath(this Stream stream, out bool isMegStream)
+    {
+        return !stream.TryGetFilePath(out var filePath, out isMegStream)
+            ? throw new InvalidOperationException("Unable to get file path from Stream")
+            : filePath;
+    }
+
+    /// <summary>
+    /// Attempts to retrieve the file path of the file opened in the specified <see cref="Stream"/>.
+    /// </summary>
+    /// <param name="stream">The stream to retrieve the file path from.</param>
+    /// <returns>
+    /// The file path of the opened file if the operation was successful; otherwise, <see langword="null"/>.
+    /// </returns>
+    public static string? TryGetFilePath(this Stream stream)
+    {
+        return stream.TryGetFilePath(out var fileName, out _) ? fileName : null;
+    }
+
+    /// <summary>
+    /// Attempts to retrieve the file path of the file opened in the specified <see cref="Stream"/>.
+    /// </summary>
+    /// <param name="stream">The stream to retrieve the file path from.</param>
+    /// <param name="fileName">
+    /// When this method returns, contains the file path of the opened file if the operation was successful; 
+    /// otherwise, <see langword="null"/>. This parameter is passed uninitialized.
+    /// </param>
+    /// <returns>
+    /// <see langword="true"/> if the file path was successfully retrieved; otherwise, <see langword="false"/>.
+    /// </returns>
+    public static bool TryGetFilePath(this Stream stream, [NotNullWhen(true)] out string? fileName)
+    {
+        return stream.TryGetFilePath(out fileName, out _);
+    }
+
+    /// <summary>
+    /// Attempts to retrieve the file path of the file opened in the specified <see cref="Stream"/>.
+    /// </summary>
+    /// <param name="stream">The stream to retrieve the file path from.</param>
+    /// <param name="fileName">
+    /// When this method returns, contains the file path of the opened file if the operation was successful; 
+    /// otherwise, <see langword="null"/>. This parameter is passed uninitialized.
+    /// </param>
+    /// <param name="isMegStream">
+    /// When this method returns, contains a value indicating whether the stream is a MEG file data stream.
+    /// </param>
+    /// <returns>
+    /// <see langword="true"/> if the file path was successfully retrieved; otherwise, <see langword="false"/>.
+    /// </returns>
+    public static bool TryGetFilePath(this Stream stream, [NotNullWhen(true)] out string? fileName, out bool isMegStream)
     {
         isMegStream = false;
-        if (stream is FileStream fileStream)
-            return fileStream.Name;
-        if (stream is FileSystemStream fileSystemStream)
-            return fileSystemStream.Name;
-        if (stream is IMegFileDataStream megFileDataStream)
+        switch (stream)
         {
-            isMegStream = true;
-            return megFileDataStream.EntryPath;
+            case FileStream fileStream:
+                fileName =  fileStream.Name;
+                break;
+            case FileSystemStream fileSystemStream:
+                fileName = fileSystemStream.Name;
+                break;
+            case IMegFileDataStream megFileDataStream:
+                isMegStream = true;
+                fileName =  megFileDataStream.EntryPath;
+                break;
+            default:
+                fileName = null;
+                return false;
         }
-
-        throw new InvalidOperationException("Unable to get file path from Stream");
+        return true;
     }
 }

PG.StarWarsGame.Files.DAT/PG.StarWarsGame.Files.DAT.Test/PG.StarWarsGame.Files.DAT.Test.csproj

@@ -36,7 +36,7 @@
 		<PackageReference Include="GitHubActionsTestLogger" Version="3.0.1" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.0.1" />
 		<PackageReference Include="xunit.v3.mtp-v2" Version="3.2.2" />
-		<PackageReference Include="Microsoft.Testing.Platform" Version="2.0.2" />
+		<PackageReference Include="Microsoft.Testing.Platform" Version="2.1.0" />
 		<PackageReference Include="coverlet.msbuild" Version="6.0.4">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

PG.StarWarsGame.Files.DAT/PG.StarWarsGame.Files.DAT/Services/Builder/Builders/EmpireAtWarMasterTextBuilder.cs

@@ -19,7 +19,7 @@ public sealed class EmpireAtWarMasterTextBuilder : PetroglyphStarWarsGameDatBuil
     /// <summary>
     /// Initializes a new instance of the <see cref="EmpireAtWarCreditsTextBuilder"/> class.
     /// </summary>
-    /// <param name="overwriteDuplicates"></param>
+    /// <param name="overwriteDuplicates">Specifies how the build treats duplicates.</param>
     /// <param name="services">The service provider.</param>
     public EmpireAtWarMasterTextBuilder(bool overwriteDuplicates, IServiceProvider services) 
         : base(overwriteDuplicates ? BuilderOverrideKind.Overwrite : BuilderOverrideKind.NoOverwrite, services)

PG.StarWarsGame.Files.DAT/PG.StarWarsGame.Files.DAT/Services/Builder/DatBuilderBase.cs

@@ -48,7 +48,7 @@ public abstract class DatBuilderBase : FileBuilderBase<IReadOnlyList<DatStringEn
     /// <summary>
     /// Initializes a new instance of the <see cref="DatBuilderBase"/> class.
     /// </summary>
-    /// <param name="overrideKind"></param>
+    /// <param name="overrideKind">Specifies how the build treats duplicate entries.</param>
     /// <param name="services">The service provider.</param>
     protected DatBuilderBase(BuilderOverrideKind overrideKind, IServiceProvider services) : base(services)
     {