Refactor

Package.swift

@@ -1,94 +1,233 @@
-// swift-tools-version:5.9
+// swift-tools-version:6.1
 
 import PackageDescription
 
 let package = Package(
     name: "swift-compression",
     // MARK: Products
     products: [
-        .library(
-            name: "SwiftCompression",
-            targets: ["SwiftCompression"]
-        ),
+        .library(name: "SwiftCompression", targets: ["SwiftCompression"]),
+        .library(name: "SwiftCompressionUtilities", targets: ["SwiftCompressionUtilities"]),
 
-        .library(
-            name: "SwiftCompressionCSS",
-            targets: ["CompressionCSS"]
-        ),
+        .library(name: "Brotli", targets: ["Brotli"]),
+        .library(name: "SwiftCompressionDNA", targets: ["CompressionDNA"]),
+        .library(name: "SwiftCompressionLZ", targets: ["CompressionLZ"]),
+        .library(name: "FrequencyTables", targets: ["FrequencyTables"]),
+        .library(name: "Huffman", targets: ["Huffman"]),
+        .library(name: "RunLengthEncoding", targets: ["RunLengthEncoding"]),
+        .library(name: "Snappy", targets: ["Snappy"]),
+        .library(name: "Zlib", targets: ["Zlib"])
+    ],
+    // MARK: Traits
+    traits: [
+        .default(enabledTraits: [
+            "Brotli",
+            "Huffman",
+            "LZ77",
+            "RunLengthEncoding",
+            "Snappy",
+            "ZlibDeflate",
+            "ZlibGzip",
 
-        .library(
-            name: "SwiftCompressionDNA",
-            targets: ["CompressionDNA"]
-        ),
+            "AlgorithmAnyCompressor",
+            "AlgorithmAnyDecompressor",
 
-        .library(
-            name: "SwiftCompressionJavaScript",
-            targets: ["CompressionJavaScript"]
-        ),
+            "CollectionCompress", "CollectionDecompress",
+            "FoundationCompress", "FoundationDecompress",
+            "BrotliCompress", "BrotliDecompress",
+            "HuffmanCompress", "HuffmanDecompress",
+            "LZ77Compress", "LZ77Decompress",
+            "SnappyCompress", "SnappyDecompress",
+            "RunLengthEncodingCompress", "RunLengthEncodingDecompress",
+            "ZlibDeflateCompress", "ZlibDeflateDecompress",
+            "ZlibGzipCompress", "ZlibGzipDecompress",
+        ]),
 
-        .library(
-            name: "SwiftCompressionLZ",
-            targets: ["CompressionLZ"]
-        ),
+        .trait(name: "AlgorithmAnyCompressor", description: "Enables the `compressor: (any Compressor)?` computed property for `CompressionAlgorithm`."),
+        .trait(name: "AlgorithmAnyDecompressor", description: "Enables the `decompressor: (any Decompressor)?` computed property for `CompressionAlgorithm`."),
 
-        .library(
-            name: "SwiftCompressionSnappy",
-            targets: ["CompressionSnappy"]
-        ),
+        .trait(name: "CollectionCompress", enabledTraits: [
+            "BrotliCompressCollection",
+            "HuffmanCompressCollection",
+            "LZ77CompressCollection",
+            "RunLengthEncodingCompressCollection",
+            "SnappyCompressCollection",
+            "ZlibDeflateCompressCollection",
+            "ZlibGzipCompressCollection",
+        ]),
+
+        .trait(name: "CollectionDecompress", enabledTraits: [
+            "BrotliDecompressCollection",
+            "HuffmanDecompressCollection",
+            "LZ77DecompressCollection",
+            "RunLengthEncodingDecompressCollection",
+            "SnappyDecompressCollection",
+            "ZlibDeflateDecompressCollection",
+            "ZlibGzipDecompressCollection",
+        ]),
+
+        .trait(name: "FoundationCompress", enabledTraits: [
+            "BrotliCompressFoundation",
+            "HuffmanCompressFoundation",
+            "LZ77CompressFoundation",
+            "RunLengthEncodingCompressFoundation",
+            "SnappyCompressFoundation",
+            "ZlibDeflateCompressFoundation",
+            "ZlibGzipCompressFoundation",
+        ]),
+
+        .trait(name: "FoundationDecompress", enabledTraits: [
+            "BrotliDecompressFoundation",
+            "HuffmanDecompressFoundation",
+            "LZ77DecompressFoundation",
+            "RunLengthEncodingDecompressFoundation",
+            "SnappyDecompressFoundation",
+            "ZlibDeflateDecompressFoundation",
+            "ZlibGzipDecompressFoundation",
+        ]),
+
+        .trait(name: "Brotli", description: "Enables Brotli."),
+        .trait(name: "BrotliCompress", description: "Enables Brotli compression for Span<UInt8>.", enabledTraits: ["Brotli"]),
+        .trait(name: "BrotliCompressCollection", description: "Enables Brotli compression for some Collection<UInt8>.", enabledTraits: ["BrotliCompress"]),
+        .trait(name: "BrotliCompressFoundation", description: "Enables Brotli compression for FoundationEssentials.Data.", enabledTraits: ["BrotliCompress"]),
+        .trait(name: "BrotliDecompress", description: "Enables Brotli decompression for Span<UInt8>.", enabledTraits: ["Brotli"]),
+        .trait(name: "BrotliDecompressCollection", description: "Enables Brotli decompression for some Collection<UInt8>.", enabledTraits: ["BrotliDecompress"]),
+        .trait(name: "BrotliDecompressFoundation", description: "Enables Brotli decompression for FoundationEssentials.Data.", enabledTraits: ["BrotliDecompress"]),
+
+        .trait(name: "Huffman", description: "Enables Huffman."),
+        .trait(name: "HuffmanCompress", description: "Enables Huffman compression for Span<UInt8>.", enabledTraits: ["Huffman"]),
+        .trait(name: "HuffmanCompressCollection", description: "Enables Huffman compression for some Collection<UInt8>.", enabledTraits: ["HuffmanCompress"]),
+        .trait(name: "HuffmanCompressFoundation", description: "Enables Huffman compression for FoundationEssentials.Data.", enabledTraits: ["HuffmanCompress"]),
+        .trait(name: "HuffmanDecompress", description: "Enables Huffman decompression for Span<UInt8>.", enabledTraits: ["Huffman"]),
+        .trait(name: "HuffmanDecompressCollection", description: "Enables Huffman decompression for some Collection<UInt8>.", enabledTraits: ["HuffmanDecompress"]),
+        .trait(name: "HuffmanDecompressFoundation", description: "Enables Huffman decompression for FoundationEssentials.Data.", enabledTraits: ["HuffmanDecompress"]),
+
+        .trait(name: "LZ77", description: "Enables LZ77."),
+        .trait(name: "LZ77Compress", description: "Enables LZ77 compression for Span<UInt8>.", enabledTraits: ["LZ77"]),
+        .trait(name: "LZ77CompressCollection", description: "Enables LZ77 compression for some Collection<UInt8>.", enabledTraits: ["LZ77Compress"]),
+        .trait(name: "LZ77CompressFoundation", description: "Enables LZ77 compression for FoundationEssentials.Data.", enabledTraits: ["LZ77Compress"]),
+        .trait(name: "LZ77Decompress", description: "Enables LZ77 decompression for Span<UInt8>.", enabledTraits: ["LZ77"]),
+        .trait(name: "LZ77DecompressCollection", description: "Enables LZ77 decompression for some Collection<UInt8>.", enabledTraits: ["LZ77Decompress"]),
+        .trait(name: "LZ77DecompressFoundation", description: "Enables LZ77 decompression for FoundationEssentials.Data.", enabledTraits: ["LZ77Decompress"]),
+
+        .trait(name: "RunLengthEncoding", description: "Enables RunLengthEncoding."),
+        .trait(name: "RunLengthEncodingCompress", description: "Enables RunLengthEncoding compression for Span<UInt8>.", enabledTraits: ["RunLengthEncoding"]),
+        .trait(name: "RunLengthEncodingCompressCollection", description: "Enables RunLengthEncoding compression for some Collection<UInt8>.", enabledTraits: ["RunLengthEncodingCompress"]),
+        .trait(name: "RunLengthEncodingCompressFoundation", description: "Enables RunLengthEncoding compression for FoundationEssentials.Data.", enabledTraits: ["RunLengthEncodingCompress"]),
+        .trait(name: "RunLengthEncodingDecompress", description: "Enables RunLengthEncoding decompression for Span<UInt8>.", enabledTraits: ["RunLengthEncoding"]),
+        .trait(name: "RunLengthEncodingDecompressCollection", description: "Enables RunLengthEncoding decompression for some Collection<UInt8>.", enabledTraits: ["RunLengthEncodingDecompress"]),
+        .trait(name: "RunLengthEncodingDecompressFoundation", description: "Enables RunLengthEncoding decompression for FoundationEssentials.Data.", enabledTraits: ["RunLengthEncodingDecompress"]),
+
+        .trait(name: "Snappy", description: "Enables Snappy."),
+        .trait(name: "SnappyCompress", description: "Enables Snappy compression for Span<UInt8>.", enabledTraits: ["Snappy"]),
+        .trait(name: "SnappyCompressCollection", description: "Enables Snappy compression for some Collection<UInt8>.", enabledTraits: ["SnappyCompress"]),
+        .trait(name: "SnappyCompressFoundation", description: "Enables Snappy compression for FoundationEssentials.Data.", enabledTraits: ["SnappyCompress"]),
+        .trait(name: "SnappyDecompress", description: "Enables Snappy decompression for Span<UInt8>.", enabledTraits: ["Snappy"]),
+        .trait(name: "SnappyDecompressCollection", description: "Enables Snappy decompression for some Collection<UInt8>.", enabledTraits: ["SnappyDecompress"]),
+        .trait(name: "SnappyDecompressFoundation", description: "Enables Snappy decompression for FoundationEssentials.Data.", enabledTraits: ["SnappyDecompress"]),
+
+        .trait(name: "ZlibDeflate", description: "Enables ZlibDeflate."),
+        .trait(name: "ZlibDeflateCompress", description: "Enables ZlibDeflate compression for Span<UInt8>.", enabledTraits: ["ZlibDeflate"]),
+        .trait(name: "ZlibDeflateCompressCollection", description: "Enables ZlibDeflate compression for some Collection<UInt8>.", enabledTraits: ["ZlibDeflateCompress"]),
+        .trait(name: "ZlibDeflateCompressFoundation", description: "Enables ZlibDeflate compression for FoundationEssentials.Data.", enabledTraits: ["ZlibDeflateCompress"]),
+        .trait(name: "ZlibDeflateDecompress", description: "Enables ZlibDeflate decompression for Span<UInt8>.", enabledTraits: ["ZlibDeflate"]),
+        .trait(name: "ZlibDeflateDecompressCollection", description: "Enables ZlibDeflate decompression for some Collection<UInt8>.", enabledTraits: ["ZlibDeflateDecompress"]),
+        .trait(name: "ZlibDeflateDecompressFoundation", description: "Enables ZlibDeflate decompression for FoundationEssentials.Data.", enabledTraits: ["ZlibDeflateDecompress"]),
+
+        .trait(name: "ZlibGzip", description: "Enables ZlibGzip"),
+        .trait(name: "ZlibGzipCompress", description: "Enables ZlibGzip compression for Span<UInt8>.", enabledTraits: ["ZlibGzip", "ZlibDeflateCompress"]),
+        .trait(name: "ZlibGzipCompressCollection", description: "Enables ZlibGzip compression for some Collection<UInt8>.", enabledTraits: ["ZlibGzipCompress"]),
+        .trait(name: "ZlibGzipCompressFoundation", description: "Enables ZlibGzip compression for FoundationEssentials.Data.", enabledTraits: ["ZlibGzipCompress"]),
+        .trait(name: "ZlibGzipDecompress", description: "Enables ZlibGzip decompression for Span<UInt8>.", enabledTraits: ["ZlibGzip", "ZlibDeflateDecompress"]),
+        .trait(name: "ZlibGzipDecompressCollection", description: "Enables ZlibGzip decompression for some Collection<UInt8>.", enabledTraits: ["ZlibGzipDecompress"]),
+        .trait(name: "ZlibGzipDecompressFoundation", description: "Enables ZlibGzip decompression for FoundationEssentials.Data.", enabledTraits: ["ZlibGzipDecompress"]),
     ],
+
     // MARK: Targets
     targets: [
-        .target(
-            name: "SwiftCompressionUtilities"
-        ),
+        .target(name: "ByteBuilder"),
+        .target(name: "FrequencyTables"),
+        .target(name: "SwiftCompressionUtilities"),
 
         .target(
             name: "SwiftCompression",
             dependencies: [
-                "SwiftCompressionUtilities",
-                "CompressionCSS",
+                "Brotli",
                 "CompressionDNA",
-                "CompressionJavaScript",
                 "CompressionLZ",
-                "CompressionSnappy"
+                "Huffman",
+                "RunLengthEncoding",
+                "Snappy",
+                "Zlib",
+                "SwiftCompressionUtilities",
             ]
         ),
 
-        // MARK: Techniques
+        .systemLibrary(name: "BrotliShim"),
         .target(
-            name: "CompressionCSS",
+            name: "Brotli",
             dependencies: [
-                "SwiftCompressionUtilities"
+                "SwiftCompressionUtilities",
+                "BrotliShim"
             ],
-            path: "Sources/CSS"
+            linkerSettings: [
+                .unsafeFlags(["-lbrotlienc"], .when(traits: ["BrotliCompress"])),
+                .unsafeFlags(["-lbrotlidec"], .when(traits: ["BrotliDecompress"]))
+            ]
         ),
+        .systemLibrary(name: "ZlibShim"),
+        .target(
+            name: "Zlib",
+            dependencies: [
+                "SwiftCompressionUtilities",
+                "ZlibShim"
+            ]
+        ),
+
         .target(
             name: "CompressionDNA",
             dependencies: [
+                "ByteBuilder",
+                "FrequencyTables",
                 "SwiftCompressionUtilities"
             ],
             path: "Sources/DNA"
         ),
         .target(
-            name: "CompressionJavaScript",
+            name: "CompressionLZ",
             dependencies: [
+                "ByteBuilder",
                 "SwiftCompressionUtilities"
             ],
-            path: "Sources/JavaScript"
+            path: "Sources/LZ"
         ),
+
         .target(
-            name: "CompressionLZ",
+            name: "Huffman",
             dependencies: [
+                "ByteBuilder",
                 "SwiftCompressionUtilities"
-            ],
-            path: "Sources/LZ"
+            ]
         ),
+
         .target(
-            name: "CompressionSnappy",
+            name: "RunLengthEncoding",
             dependencies: [
                 "SwiftCompressionUtilities"
+            ]
+        ),
+
+        .systemLibrary(name: "SnappyShim"),
+        .target(
+            name: "Snappy",
+            dependencies: [
+                "ByteBuilder",
+                "SwiftCompressionUtilities",
+                "SnappyShim"
             ],
-            path: "Sources/Snappy"
+            linkerSettings: [
+                .unsafeFlags(["-lsnappy"], .when(traits: ["Snappy"]))
+            ]
         ),
 
         // MARK: Run
@@ -100,30 +239,12 @@ let package = Package(
         ),
 
         // MARK: Unit tests
-        .testTarget(
-            name: "SwiftCompressionTests",
-            dependencies: ["SwiftCompression"]
-        ),
-        .testTarget(
-            name: "CSSTests",
-            dependencies: ["CompressionCSS"]
-        ),
-        .testTarget(
-            name: "DNATests",
-            dependencies: ["CompressionDNA"]
-        ),
-        .testTarget(
-            name: "JavaScriptTests",
-            dependencies: ["CompressionJavaScript"]
-        ),
-        .testTarget(
-            name: "LZTests",
-            dependencies: ["CompressionLZ"]
-        ),
-        .testTarget(
-            name: "SnappyTests",
-            dependencies: ["CompressionSnappy"]
-        )
+        .testTarget(name: "SwiftCompressionTests", dependencies: ["SwiftCompression"]),
+        .testTarget(name: "BrotliTests", dependencies: ["Brotli"]),
+        .testTarget(name: "DNATests", dependencies: ["CompressionDNA"]),
+        .testTarget(name: "LZTests", dependencies: ["CompressionLZ"]),
+        .testTarget(name: "SnappyTests", dependencies: ["Snappy"]),
+        .testTarget(name: "ZlibTests", dependencies: ["Zlib"])
     ]
 )
 

README.md

@@ -1,33 +1,29 @@
 # Swift Compression
 
-<a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-5.9+-F05138?style=&logo=swift" alt="Requires at least Swift 5.9"></a> <img src="https://img.shields.io/badge/Platforms-Any-gold"> <a href="https://discord.com/invite/VyuFQUpcUz"><img src="https://img.shields.io/badge/Chat-Discord-7289DA?style=&logo=discord"></a> <a href="https://github.com/RandomHashTags/destiny/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue" alt="Apache 2.0 License"></a>
+<a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-5.9+-F05138?style=&logo=swift" alt="Requires at least Swift 5.9"></a> <img src="https://img.shields.io/badge/Platforms-Any-gold"> <a href="./LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue" alt="Apache 2.0 License"></a>
 
 Standalone compression & decompression library.
 
 ## Techniques
 
 ### Compression and decompression
 
-- [Brotli](https://github.com/google/brotli)
-- [DEFLATE](https://www.rfc-editor.org/rfc/rfc1951)
-- [DNA Binary Encoding](https://en.wikipedia.org/wiki/DNA_digital_data_storage)
-- [DNA Single-Block Encoding](https://www.mdpi.com/1999-4893/13/4/99)
-- [Huffman Coding](https://en.wikipedia.org/wiki/Huffman_coding)
-- [iWork Archive](https://en.wikipedia.org/wiki/IWork)
-- [LZ77 & LZ78](https://en.wikipedia.org/wiki/LZ77_and_LZ78)
-- [Move-to-front](https://en.wikipedia.org/wiki/Move-to-front_transform)
-- [Run-Length Encoding](https://en.wikipedia.org/wiki/Run-length_encoding)
-- [Snappy](https://github.com/google/snappy)
-- [Snappy Framed](https://github.com/google/snappy/blob/main/framing_format.txt)
-- [Zstd](https://github.com/facebook/zstd)
-
-### Minification
-
-- CSS
-- JavaScript
-- Swift
-
-## Getting starting
+- [x] [Brotli](https://github.com/google/brotli)
+- [ ] [DEFLATE](https://www.rfc-editor.org/rfc/rfc1951)
+    - [x] via zlib
+    - [ ] via libdeflate
+- [x] [DNA Binary Encoding](https://en.wikipedia.org/wiki/DNA_digital_data_storage)
+- [ ] [DNA Single-Block Encoding](https://www.mdpi.com/1999-4893/13/4/99)
+- [x] [Huffman Coding](https://en.wikipedia.org/wiki/Huffman_coding)
+- [ ] [iWork Archive](https://en.wikipedia.org/wiki/IWork)
+- [ ] [LZ77 & LZ78](https://en.wikipedia.org/wiki/LZ77_and_LZ78)
+- [x] [Move-to-front](https://en.wikipedia.org/wiki/Move-to-front_transform)
+- [x] [Run-Length Encoding](https://en.wikipedia.org/wiki/Run-length_encoding)
+- [x] [Snappy](https://github.com/google/snappy)
+- [ ] [Snappy Framed](https://github.com/google/snappy/blob/main/framing_format.txt)
+- [ ] [Zstd](https://github.com/facebook/zstd)
+
+## Getting started
 
 coming soon...
 
@@ -36,11 +32,11 @@ coming soon...
 The products are broken up into their respective algorithms, but the __SwiftCompression__ product includes all of them and is the recommended one to use in your projects.
 
 - SwiftCompression
-- SwiftCompressionCSS
 - SwiftCompressionDNA
-- SwiftCompressionJavaScript
 - SwiftCompressionLZ
-- SwiftCompressionSnappy
+- Brotli
+- Snappy
+- Zlib
 
 ## Contributing