Merge pull request #1 from sator-imaging/v2.0

V2.0

Author: sator-imaging

README.md

@@ -1,16 +1,15 @@
-TAR Archiver for C# / .NET
-==========================
+TAR Archiver for .NET / Unity
+=============================
 
-Minimal C# implementation for creating TAR archive (.tar/.tar.gz/.tgz)
+Minimal C# implementation for creating TAR archive. (.tar/.tar.gz/.tgz)
 
 This library is built based on the codes from [SharpCompress](https://github.com/adamhathcock/sharpcompress) library with:
 
 - `unsafe` Context Removal
     - `Span<T> = stackalloc T` Remain Untouched &nbsp; <small>* Require C# 7.3 or Later</small>
-- Nullables Removal
-- `System.Buffers` Dependency Removal
 - Unity Ready without additional DLL Installation
 - Support for Unity Package Manager
+- Unity 2021 LTS or Later
 
 
 
@@ -29,7 +28,6 @@ Not complicated. The only feature is creating TAR archive from `string`, `byte[]
 Thanks to `System.IO.Compression` library, you can also create `.tar.gz` (`.tgz`) archive on the fly.
 
 
-
 ```csharp
 using SatorImaging.TarArchiver;
 using System;
@@ -56,6 +54,9 @@ public class Sample
             tar.Flush();  // done in TarStream.Dispose() anyway
         }
 
+        // NOTE: To use MemoryStream instead of FileStream for underlying base stream
+        //       of GZipStream, it must be CLOSED before calling MemoryStream.ToArray().
+        //       GZipStream.Flush() won't write anything, close it first.
     }
 }
 ```
@@ -161,19 +162,6 @@ Use the following git URL to import this library using Unity Package Manager (UP
 - v1.0.0:  `https://github.com/sator-imaging/CSharp-TarArchiver.git#v1.0.0`
 
 
-Note that `src/Sample.cs` will add menu to Unity Editor that shows dialog for exporting test file.
+Note that `src/Tests.cs` will add menu to Unity Editor that shows dialog for exporting test file.
 
 ![](https://dl.dropbox.com/s/5qkzw1j4a0ony5a/CSharp-TarArchiver.png)
-
-
-
-# Changelog
-
-- Nullables removed.
-
-- Added rethrow code original one doesn't.
-
-- `stackalloc`: removed
-- `Span<T> = stackalloc T`: untouched
-- `ArrayPool<Byte>`: removed
-- `BinaryPrimitives.WriteInt64BigEndian`: polyfilled

package.json

@@ -1,19 +1,21 @@
-{
-  "name": "com.sator-imaging.tar-archiver",
-  "displayName": "TAR Archiver for C# / .NET",
-  "version": "1.0.2",
-  "unity": "2021.3",
-  "description": "Minimal C# implementation for creating TAR (.tar) archive file.",
-
-  "author": {
-    "name": "Sator Imaging",
-    "url": "https://www.sator-imaging.com/"
-  },
-
-  "category": "tar",
-  "keywords": [
-    "tar",
-    "archive"
-  ]
-
-}
+{
+  "name": "com.sator-imaging.tar-archiver",
+  "displayName": "TAR Archiver for .NET / Unity",
+  "version": "2.0.0",
+  "unity": "2021.3",
+  "description": "Minimal C# implementation for creating TAR (.tar) archive file.",
+  "author": {
+    "name": "Sator Imaging",
+    "url": "https://x.com/sator_imaging"
+  },
+  "category": "tar",
+  "keywords": [
+    "unity",
+    "tar",
+    "archive"
+  ],
+  "url":              "https://github.com/sator-imaging/CSharp-TarArchiver.git",
+  "documentationUrl": "https://github.com/sator-imaging/CSharp-TarArchiver",
+  "changelogUrl":     "https://github.com/sator-imaging/CSharp-TarArchiver",
+  "licensesUrl":      "https://www.sator-imaging.com/"
+}

src/Sample.cs

@@ -1,40 +1,49 @@
-using SatorImaging.TarArchiver;
+#if DEBUG
+
 using System;
 using System.IO;
 using System.IO.Compression;
 
+#nullable enable
 
-public class Sample
+namespace SatorImaging.TarArchiver
 {
-
-
-#if UNITY_EDITOR
-    [UnityEditor.MenuItem(nameof(SatorImaging.TarArchiver) + "/Create Test File")]
-    static void CreateTestFile()
+    public class Tests
     {
-        var path = UnityEditor.EditorUtility.SaveFilePanel(nameof(SatorImaging.TarArchiver), "", "TestFile", @"tar.gz");
-        Main(new string[] { path });
-    }
-#endif
-
+#if UNITY_EDITOR
+        [UnityEditor.MenuItem("TEST/" + nameof(TarArchiver) + "/Create Test File...")]
+        static void Create_Test_File()
+        {
+            var path = UnityEditor.EditorUtility.SaveFilePanel(
+                nameof(TarArchiver), string.Empty, "TestFile", @"tar.gz");
 
-    static void Main(string[] args)
-    {
-        if (args.Length == 0 || string.IsNullOrWhiteSpace(args[0]))
-            throw new ArgumentNullException(nameof(args));
+            CreateTestFile(new string[] { path });
+            UnityEditor.EditorUtility.RevealInFinder(path);
+        }
+#endif
 
-        // open TAR stream and export as a .tar.gz format
-        using (var targz = new FileStream(args[0], FileMode.Create, FileAccess.Write))
-        using (var gzip = new GZipStream(targz, CompressionLevel.Optimal))
-        using (var tar = new TarStream(gzip))
+        static void CreateTestFile(string[] args)
         {
-            // writing data
-            tar.Write(@"path/to/the/file.txt", @"Hello, World.");
-            tar.Write(@"path/with/multibyte/文字列.txt", @"ひらがなカタカナ漢字");
-            tar.Write(@"yet-another-folder/byteArray.txt", new byte[] { 84, 65, 82, 13, 10 });  //TAR[CR][LF]
-            tar.Write(@"root.txt", "");
-            tar.Flush();  // done in TarStream.Dispose() anyway
+            if (args.Length == 0 || string.IsNullOrWhiteSpace(args[0]))
+                throw new ArgumentNullException(nameof(args));
+
+            // open TAR stream and export as a .tar.gz format
+            using (var targz = new FileStream(args[0], FileMode.Create, FileAccess.Write))
+            using (var gzip = new GZipStream(targz, CompressionLevel.Optimal))
+            using (var tar = new TarStream(gzip))
+            {
+                // writing data
+                tar.Write(@"path/to/the/file.txt", @"Hello, World.");
+                tar.Write(@"path/with/multibyte/文字列.txt", @"ひらがなカタカナ漢字");
+                tar.Write(@"yet-another-folder/byteArray.txt", new byte[] { 84, 65, 82, 13, 10 });  //TAR[CR][LF]
+                tar.Write(@"root.txt", "");
+                tar.Flush();  // done in TarStream.Dispose() anyway
+            }
+
+            // NOTE: To use MemoryStream instead of FileStream for underlying base stream
+            //       of GZipStream, it must be CLOSED before calling MemoryStream.ToArray().
+            //       GZipStream.Flush() won't write anything, close it first.
         }
-
     }
 }
+#endif

src/TarHeader.cs

@@ -2,13 +2,15 @@
 using System.IO;
 using System.Text;
 
+#nullable enable
 
 namespace SatorImaging.TarArchiver
 {
     public class TarHeader
     {
         const int BLOCK_SIZE = 512;
-        static DateTime EPOCH = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
+        static readonly DateTime EPOCH = new(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
+        static readonly Encoding ArchiveEncoding = Encoding.UTF8;
 
         enum EEntryType : byte
         {
@@ -27,18 +29,15 @@ enum EEntryType : byte
             GlobalExtendedHeader = (byte)'g'
         }
 
-        EEntryType EntryType;
-        Encoding ArchiveEncoding = Encoding.UTF8;
 
-
-        internal string Name { get; set; }
+        internal string Name { get; set; } = string.Empty;
         internal long Size { get; set; }
         internal DateTime LastModifiedTime { get; set; }
 
 
         internal void Write(Stream output)
         {
-            byte[] buffer = new byte[BLOCK_SIZE];
+            var buffer = (stackalloc byte[BLOCK_SIZE]);
 
             WriteOctalBytes(511, buffer, 100, 8); // file mode
             WriteOctalBytes(0, buffer, 108, 8); // owner ID
@@ -59,21 +58,21 @@ internal void Write(Stream output)
                 WriteOctalBytes(Size, buffer, 124, 12);
                 var time = (long)(LastModifiedTime.ToUniversalTime() - EPOCH).TotalSeconds;
                 WriteOctalBytes(time, buffer, 136, 12);
-                buffer[156] = (byte)EntryType;
+                buffer[156] = (byte)(default(EEntryType));
 
                 if (Size >= 0x1FFFFFFFF)
                 {
                     Span<byte> bytes12 = stackalloc byte[12];
                     BinaryPrimitives_WriteInt64BigEndian(bytes12.Slice(4), Size);
                     bytes12[0] |= 0x80;
-                    bytes12.CopyTo(buffer.AsSpan(124));
+                    bytes12.CopyTo(buffer.Slice(124));
                 }
             }
 
             int crc = RecalculateChecksum(buffer);
             WriteOctalBytes(crc, buffer, 148, 8);
 
-            output.Write(buffer, 0, buffer.Length);
+            output.Write(buffer);
 
             if (nameByteCount > 100)
             {
@@ -91,10 +90,8 @@ internal void Write(Stream output)
         }
 
 
-
         #region ////////  Utility  ////////
 
-
         static void BinaryPrimitives_WriteInt64BigEndian(Span<byte> destination, long value)
         {
             var bytes = BitConverter.GetBytes(value).AsSpan<byte>();
@@ -106,7 +103,7 @@ static void BinaryPrimitives_WriteInt64BigEndian(Span<byte> destination, long va
         }
 
 
-        static void WriteOctalBytes(long value, byte[] buffer, int offset, int length)
+        static void WriteOctalBytes(long value, Span<byte> buffer, int offset, int length)
         {
             var val = Convert.ToString(value, 8);
             var shift = length - val.Length - 1;
@@ -128,7 +125,7 @@ static void WriteStringBytes(ReadOnlySpan<byte> name, Span<byte> buffer, int len
             buffer.Slice(i, length - i).Clear();
         }
 
-        static void WriteStringBytes(string name, byte[] buffer, int offset, int length)
+        static void WriteStringBytes(string name, Span<byte> buffer, int offset, int length)
         {
             int i;
 
@@ -155,7 +152,7 @@ void WriteLongFilenameHeader(Stream output)
             {
                 numPaddingBytes = BLOCK_SIZE;
             }
-            output.Write(new byte[numPaddingBytes]);
+            output.Write(stackalloc byte[numPaddingBytes]);
         }
 
 
@@ -171,10 +168,10 @@ void WriteLongFilenameHeader(Stream output)
                 (byte)' ',
             };
 
-        static int RecalculateChecksum(byte[] buf)
+        static int RecalculateChecksum(Span<byte> buf)
         {
             // Set default value for checksum. That is 8 spaces.
-            eightSpaces.CopyTo(buf, 148);
+            eightSpaces.CopyTo(buf.Slice(148));
 
             // Calculate checksum
             var headerChecksum = 0;
@@ -185,10 +182,6 @@ static int RecalculateChecksum(byte[] buf)
             return headerChecksum;
         }
 
-
         #endregion
-
-
-
     }
 }