Parse Bitmask

.github/workflows/benchmark.yml

@@ -0,0 +1,33 @@
+name: Benchmark
+on:
+  workflow_run:
+    workflows: ["CI"]
+    types:
+      - completed
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+permissions:
+  contents: write
+  pull-requests: write
+jobs:
+  benchmark:
+    name: Run Benchmarks
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
+    runs-on: macOS-26
+    env:
+      DEVELOPER_DIR: "/Applications/Xcode_26.0.app/Contents/Developer"
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - name: Swift Version
+        run: xcrun swift --version
+      - name: Install jemalloc
+        run: |
+          echo "/opt/homebrew/bin:/usr/local/bin" >> $GITHUB_PATH
+          brew install jemalloc
+      - name: Run Parsing Benchmarks
+        run: |
+          xcrun swift package benchmark --format markdown >> $GITHUB_STEP_SUMMARY

.github/workflows/ci.yml

@@ -26,7 +26,8 @@ jobs:
     env:
       DEVELOPER_DIR: "/Applications/Xcode_26.0.app/Contents/Developer"
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v6
       - name: Swift Version
         run: xcrun swift --version
       - name: Install SwiftLint
@@ -59,7 +60,7 @@ jobs:
         run: |
           set -o pipefail && \
           xcodebuild test \
-          -scheme BinaryParseKit-Package \
+          -scheme BinaryParseKit \
           -destination 'platform=macOS' \
           -skipMacroValidation | xcbeautify --renderer github-actions
 

.github/workflows/deploy-docc.yml

@@ -18,7 +18,7 @@ jobs:
       DEVELOPER_DIR: "/Applications/Xcode_26.1.app/Contents/Developer"
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       - name: Swift Version
         run: xcrun swift --version
       - name: Build DocC

.pre-commit-config.yaml

@@ -15,12 +15,6 @@ repos:
         language: system
         types: [swift]
         stages: [pre-commit]
-      - id: swiftlint fix
-        name: SwiftLintFix
-        entry: swiftlint . --fix --config .swiftlint.yml
-        language: system
-        types: [swift]
-        stages: [pre-commit]
       - id: swiftlint check
         name: SwiftLintCheck
         entry: swiftlint . --strict --config .swiftlint.yml

.swiftlint.yml

@@ -33,7 +33,9 @@ identifier_name:
     - j
     - x
     - y
-  allowed_symbols: ["_"]
+  allowed_symbols: ["_", " "]
 cyclomatic_complexity:
   warning: 20
   error: 25
+type_name:
+  allowed_symbols: [" "]

.swiftpm/xcode/xcshareddata/xcschemes/BinaryParseKit-Package.xcscheme

@@ -35,6 +35,34 @@
                ReferencedContainer = "container:">
             </BuildableReference>
          </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "ParsingBenchmarks"
+               BuildableName = "ParsingBenchmarks"
+               BlueprintName = "ParsingBenchmarks"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "PrintingBenchmarks"
+               BuildableName = "PrintingBenchmarks"
+               BlueprintName = "PrintingBenchmarks"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
       </BuildActionEntries>
    </BuildAction>
    <TestAction
@@ -43,15 +71,18 @@
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES">
       <TestPlans>
+         <TestPlanReference
+            reference = "container:TestPlans/All.xctestplan"
+            default = "YES">
+         </TestPlanReference>
          <TestPlanReference
             reference = "container:TestPlans/Product.xctestplan">
          </TestPlanReference>
          <TestPlanReference
             reference = "container:TestPlans/Macro.xctestplan">
          </TestPlanReference>
          <TestPlanReference
-            reference = "container:TestPlans/All.xctestplan"
-            default = "YES">
+            reference = "container:TestPlans/BenchmarkTypes.xctestplan">
          </TestPlanReference>
       </TestPlans>
       <Testables>
@@ -75,6 +106,26 @@
                ReferencedContainer = "container:">
             </BuildableReference>
          </TestableReference>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "BenchmarkCommonsTests"
+               BuildableName = "BenchmarkCommonsTests"
+               BlueprintName = "BenchmarkCommonsTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "BenchmarkTypesTests"
+               BuildableName = "BenchmarkTypesTests"
+               BlueprintName = "BenchmarkTypesTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction
@@ -87,6 +138,16 @@
       debugDocumentVersioning = "YES"
       debugServiceExtension = "internal"
       allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "PrintingBenchmarks"
+            BuildableName = "PrintingBenchmarks"
+            BlueprintName = "PrintingBenchmarks"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </BuildableProductRunnable>
       <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"
@@ -103,15 +164,16 @@
       savedToolIdentifier = ""
       useCustomWorkingDirectory = "NO"
       debugDocumentVersioning = "YES">
-      <MacroExpansion>
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
          <BuildableReference
             BuildableIdentifier = "primary"
-            BlueprintIdentifier = "BinaryParseKitClient"
-            BuildableName = "BinaryParseKitClient"
-            BlueprintName = "BinaryParseKitClient"
+            BlueprintIdentifier = "PrintingBenchmarks"
+            BuildableName = "PrintingBenchmarks"
+            BlueprintName = "PrintingBenchmarks"
             ReferencedContainer = "container:">
          </BuildableReference>
-      </MacroExpansion>
+      </BuildableProductRunnable>
    </ProfileAction>
    <AnalyzeAction
       buildConfiguration = "Debug">

.swiftpm/xcode/xcshareddata/xcschemes/BinaryParseKit.xcscheme

@@ -27,8 +27,22 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES"
-      shouldAutocreateTestPlan = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <TestPlans>
+         <TestPlanReference
+            reference = "container:TestPlans/All.xctestplan"
+            default = "YES">
+         </TestPlanReference>
+         <TestPlanReference
+            reference = "container:TestPlans/Product.xctestplan">
+         </TestPlanReference>
+         <TestPlanReference
+            reference = "container:TestPlans/Macro.xctestplan">
+         </TestPlanReference>
+         <TestPlanReference
+            reference = "container:TestPlans/BenchmarkTypes.xctestplan">
+         </TestPlanReference>
+      </TestPlans>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Debug"

Benchmarks/BenchmarkTypes/BaselineParsable.swift

@@ -0,0 +1,15 @@
+//
+//  BaselineParsable.swift
+//  BinaryParseKit
+//
+//  Created by Larry Zeng on 1/6/26.
+//
+
+import Foundation
+
+/// Protocol for types that provide a baseline parsing implementation for benchmarking.
+public protocol BaselineParsable {
+    /// Parses the type from raw data without bounds checking.
+    /// Used as a baseline for performance comparison in benchmarks.
+    static func parseBaseline(_ data: Data) -> Self
+}

Benchmarks/BenchmarkTypes/BenchmarkBitmaskComplex.swift

@@ -0,0 +1,52 @@
+//
+//  BenchmarkBitmaskComplex.swift
+//  BinaryParseKit
+//
+//  Created by Larry Zeng on 1/6/26.
+//
+
+import BinaryParseKit
+import BinaryParsing
+import Foundation
+
+@ParseBitmask
+public struct BenchmarkBitmaskComplex: Equatable, Sendable, BaselineParsable {
+    public typealias RawBitsInteger = UInt32
+
+    @mask(bitCount: 1)
+    public var flag1: UInt8
+
+    @mask(bitCount: 3)
+    public var priority: UInt8
+
+    @mask(bitCount: 4)
+    public var nibble: UInt8
+
+    @mask(bitCount: 8)
+    public var byte: UInt8
+
+    @mask(bitCount: 16)
+    public var word: UInt16
+
+    public init(flag1: UInt8, priority: UInt8, nibble: UInt8, byte: UInt8, word: UInt16) {
+        self.flag1 = flag1
+        self.priority = priority
+        self.nibble = nibble
+        self.byte = byte
+        self.word = word
+    }
+
+    /// Baseline parsing - direct 32-bit extraction without bound checking
+    @inline(__always)
+    public static func parseBaseline(_ data: Data) -> BenchmarkBitmaskComplex {
+        data.withUnsafeBytes { ptr in
+            let bits = UInt32(bigEndian: ptr.load(as: UInt32.self))
+            let flag1 = UInt8((bits >> 31) & 0x01)
+            let priority = UInt8((bits >> 28) & 0x07)
+            let nibble = UInt8((bits >> 24) & 0x0F)
+            let byte = UInt8((bits >> 16) & 0xFF)
+            let word = UInt16(bits & 0xFFFF)
+            return BenchmarkBitmaskComplex(flag1: flag1, priority: priority, nibble: nibble, byte: byte, word: word)
+        }
+    }
+}

Benchmarks/BenchmarkTypes/BenchmarkBitmaskSimple.swift

@@ -0,0 +1,35 @@
+//
+//  BenchmarkBitmaskSimple.swift
+//  BinaryParseKit
+//
+//  Created by Larry Zeng on 1/6/26.
+//
+
+import BinaryParseKit
+import BinaryParsing
+import Foundation
+
+@ParseBitmask
+public struct BenchmarkBitmaskSimple: Equatable, Sendable, BaselineParsable {
+    public typealias RawBitsInteger = UInt8
+
+    @mask(bitCount: 1)
+    public var flag: UInt8
+
+    @mask(bitCount: 7)
+    public var value: UInt8
+
+    public init(flag: UInt8, value: UInt8) {
+        self.flag = flag
+        self.value = value
+    }
+
+    /// Baseline parsing - direct bit extraction without bound checking
+    @inline(__always)
+    public static func parseBaseline(_ data: Data) -> BenchmarkBitmaskSimple {
+        let byte = data[data.startIndex]
+        let flag = (byte >> 7) & 0x01
+        let value = byte & 0x7F
+        return BenchmarkBitmaskSimple(flag: flag, value: value)
+    }
+}

Benchmarks/BenchmarkTypes/BenchmarkEnumComplex.swift

@@ -0,0 +1,49 @@
+//
+//  BenchmarkEnumComplex.swift
+//  BinaryParseKit
+//
+//  Created by Larry Zeng on 1/6/26.
+//
+
+import BinaryParseKit
+import BinaryParsing
+import Foundation
+
+@ParseEnum
+public enum BenchmarkEnumComplex: Equatable, Sendable, BaselineParsable {
+    @matchAndTake(byte: 0x01)
+    @parse(endianness: .big)
+    case withInt16(Int16)
+
+    @matchAndTake(byte: 0x02)
+    @parse(endianness: .big)
+    case withUInt32(UInt32)
+
+    @matchAndTake(byte: 0x03)
+    @parse(endianness: .big)
+    @parse(endianness: .big)
+    case withTwoValues(Int16, UInt16)
+
+    @matchDefault
+    case unknown
+
+    /// Baseline parsing - direct parsing without bound checking
+    @inline(__always)
+    public static func parseBaseline(_ data: Data) -> BenchmarkEnumComplex {
+        let byte = data[data.startIndex]
+        switch byte {
+        case 0x01:
+            let value = Int16(bigEndian: data.withUnsafeBytes { $0.loadUnaligned(fromByteOffset: 1, as: Int16.self) })
+            return .withInt16(value)
+        case 0x02:
+            let value = UInt32(bigEndian: data.withUnsafeBytes { $0.loadUnaligned(fromByteOffset: 1, as: UInt32.self) })
+            return .withUInt32(value)
+        case 0x03:
+            let arg1 = Int16(bigEndian: data.withUnsafeBytes { $0.loadUnaligned(fromByteOffset: 1, as: Int16.self) })
+            let arg2 = UInt16(bigEndian: data.withUnsafeBytes { $0.loadUnaligned(fromByteOffset: 3, as: UInt16.self) })
+            return .withTwoValues(arg1, arg2)
+        default:
+            return .unknown
+        }
+    }
+}