Add debug mode

Sources/RegexBenchmark/Benchmark.swift

@@ -4,11 +4,12 @@ import Foundation
 public protocol RegexBenchmark {
   var name: String { get }
   func run()
+  func debug()
 }
 
 public struct Benchmark: RegexBenchmark {
   public let name: String
-  let regex: Regex<Substring>
+  let regex: Regex<AnyRegexOutput>
   let type: MatchType
   let target: String
 
@@ -57,9 +58,7 @@ public struct BenchmarkRunner {
   let samples: Int
 
   public init(_ suiteName: String) {
-    self.suiteName = suiteName
-    self.suite = []
-    self.samples = 20
+    self.init(suiteName, 20)
   }
 
   public init(_ suiteName: String, _ n: Int) {
@@ -108,6 +107,14 @@ public struct BenchmarkRunner {
       print("- done")
     }
   }
+
+  public func debug() {
+    print("Debugging")
+    for b in suite {
+      print("- \(b.name) \(measure(benchmark: b))")
+      b.debug()
+    }
+  }
 }
 
 /// A benchmark meant to be ran across multiple engines
@@ -130,7 +137,7 @@ struct CrossBenchmark {
   var isWhole: Bool = false
 
   func register(_ runner: inout BenchmarkRunner) {
-    let swiftRegex = try! Regex(regex, as: Substring.self)
+    let swiftRegex = try! Regex(regex)
 
     let nsPattern = isWhole ? "^" + regex + "$" : regex
     let nsRegex: NSRegularExpression

Sources/RegexBenchmark/CLI.swift

@@ -10,6 +10,9 @@ struct Runner: ParsableCommand {
 
   @Option(help: "How many samples to collect for each benchmark")
   var samples = 20
+
+  @Option(help: "Debug benchmark regexes")
+  var debug = false
 
   func makeRunner() -> BenchmarkRunner {
     var benchmark = BenchmarkRunner("RegexBench", samples)
@@ -20,15 +23,17 @@ struct Runner: ParsableCommand {
     benchmark.addHangulSyllable()
     return benchmark
   }
+
   mutating func run() throws {
     var runner = makeRunner()
     if !self.specificBenchmarks.isEmpty {
       runner.suite = runner.suite.filter { b in specificBenchmarks.contains(b.name) }
     }
-    if profile {
-      runner.profile()
-    } else {
-      runner.run()
+    switch (profile, debug) {
+    case (true, true): print("Cannot run both profile and debug")
+    case (true, false): runner.profile()
+    case (false, true): runner.debug()
+    case (false, false): runner.run()
     }
   }
 }

Sources/RegexBenchmark/Debug.swift

@@ -0,0 +1,89 @@
+extension Benchmark {
+  public func debug() {
+    switch type {
+    case .whole:
+      let result = target.wholeMatch(of: regex)
+      if let match = result {
+        if match.0.count > 100 {
+          print("- Match: len =  \(match.0.count)")
+        } else {
+          print("- Match: \(match.0)")
+        }
+      } else {
+        print("- No match found")
+      }
+    case .allMatches:
+      let results = target.matches(of: regex)
+      if results.isEmpty {
+        print("- No matches")
+        return
+      }
+
+      print("- Total matches: \(results.count)")
+      if results.count > 10 {
+        print("# Too many matches, not printing")
+        return
+      }
+
+      for match in results {
+        if match.0.count > 100 {
+          print("- Match: len =  \(match.0.count)")
+        } else {
+          print("- Match: \(match.0)")
+        }
+      }
+
+    case .first:
+      let result = target.firstMatch(of: regex)
+      if let match = result {
+        if match.0.count > 100 {
+          print("- Match: len =  \(match.0.count)")
+        } else {
+          print("- Match: \(match.0)")
+        }
+      } else {
+        print("- No match found")
+        return
+      }
+    }
+  }
+}
+
+extension NSBenchmark {
+  public func debug() {
+    switch type {
+    case .allMatches:
+      let results = regex.matches(in: target, range: range)
+      if results.isEmpty {
+        print("- No matches")
+        return
+      }
+
+      print("- Total matches: \(results.count)")
+      if results.count > 10 {
+        print("# Too many matches, not printing")
+        return
+      }
+
+      for m in results {
+        if m.range.length > 100 {
+          print("- Match: len =  \(m.range.length)")
+        } else {
+          print("- Match: \(target[Range(m.range, in: target)!])")
+        }
+      }
+    case .first:
+      let result = regex.firstMatch(in: target, range: range)
+      if let match = result {
+        if match.range.length > 100 {
+          print("- Match: len =  \(match.range.length)")
+        } else {
+          print("- Match: \(target[Range(match.range, in: target)!])")
+        }
+      } else {
+        print("- No match found")
+        return
+      }
+    }
+  }
+}