Cleanup

- make charts prettier
- underscore compileroptions
- cleanup debug

Author: rctcwyvrn

Sources/RegexBenchmark/Benchmark.swift

@@ -2,10 +2,9 @@
 @_implementationOnly import _RegexParser
 import Foundation
 
-protocol RegexBenchmark {
+protocol RegexBenchmark: Debug {
   var name: String { get }
   func run()
-  func debug()
 }
 
 protocol SwiftRegexBenchmark: RegexBenchmark {

Sources/RegexBenchmark/BenchmarkChart.swift

@@ -40,8 +40,23 @@ struct BenchmarkChart: View {
         RuleMark(y: .value("Time", 1.0))
         .foregroundStyle(.red)
         .lineStyle(.init(lineWidth: 1, dash: [2]))
+        .annotation(position: .top, alignment: .leading) {
+          Text("Baseline").foregroundStyle(.red)
+        }
 
-      }.frame(idealHeight: 400)
+      }
+      .frame(idealWidth: 800, idealHeight: 800)
+      .chartYScale(domain: 0...2.0)
+      .chartYAxis {
+        AxisMarks(values: .stride(by: 0.1))
+      }
+      .chartXAxis {
+        AxisMarks { value in
+          AxisGridLine()
+          AxisTick()
+          AxisValueLabel(value.as(String.self)!, orientation: .vertical)
+        }
+      }
     }
   }
 }

Sources/RegexBenchmark/Debug.swift

@@ -1,12 +1,21 @@
 import Foundation
 
+protocol Debug {
+  func debug()
+}
+
+extension Debug {
+  var maxStringLengthForPrint: Int { 1000 }
+  var maxMatchCountForPrint: Int { 100 }
+}
+
 extension Benchmark {
   func debug() {
     switch type {
     case .whole:
       let result = target.wholeMatch(of: regex)
       if let match = result {
-        if match.0.count > 1000 {
+        if match.0.count > maxStringLengthForPrint {
           print("- Match: len =  \(match.0.count)")
         } else {
           print("- Match: \(match.0)")
@@ -22,7 +31,7 @@ extension Benchmark {
       }
 
       print("- Total matches: \(results.count)")
-      if results.count > 100 {
+      if results.count > maxMatchCountForPrint {
         print("# Too many matches, not printing")
         let avgLen = results.map({result in String(target[result.range]).count})
           .reduce(0.0, {$0 + Double($1)}) / Double(results.count)
@@ -32,7 +41,7 @@ extension Benchmark {
       }
 
       for match in results {
-        if match.0.count > 1000 {
+        if match.0.count > maxStringLengthForPrint {
           print("- Match: len =  \(match.0.count)")
         } else {
           print("- Match: \(match.0)")
@@ -42,7 +51,7 @@ extension Benchmark {
     case .first:
       let result = target.firstMatch(of: regex)
       if let match = result {
-        if match.0.count > 1000 {
+        if match.0.count > maxStringLengthForPrint {
           print("- Match: len =  \(match.0.count)")
         } else {
           print("- Match: \(match.0)")
@@ -56,6 +65,7 @@ extension Benchmark {
 }
 
 extension NSBenchmark {
+
   func debug() {
     switch type {
     case .allMatches:
@@ -66,13 +76,13 @@ extension NSBenchmark {
       }
 
       print("- Total matches: \(results.count)")
-      if results.count > 100 {
+      if results.count > maxMatchCountForPrint {
         print("# Too many matches, not printing")
         return
       }
 
       for m in results {
-        if m.range.length > 1000 {
+        if m.range.length > maxStringLengthForPrint {
           print("- Match: len =  \(m.range.length)")
         } else {
           print("- Match: \(target[Range(m.range, in: target)!])")
@@ -81,7 +91,7 @@ extension NSBenchmark {
     case .first:
       let result = regex.firstMatch(in: target, range: range)
       if let match = result {
-        if match.range.length > 1000 {
+        if match.range.length > maxStringLengthForPrint {
           print("- Match: len =  \(match.range.length)")
         } else {
           print("- Match: \(target[Range(match.range, in: target)!])")

Sources/_StringProcessing/ByteCodeGen.swift

@@ -22,12 +22,12 @@ extension Compiler {
     /// This is used to determine whether to apply initial options.
     var hasEmittedFirstMatchableAtom = false
 
-    private let compileOptions: CompileOptions
+    private let compileOptions: _CompileOptions
     fileprivate var optimizationsEnabled: Bool { !compileOptions.contains(.disableOptimizations) }
 
     init(
       options: MatchingOptions,
-      compileOptions: CompileOptions,
+      compileOptions: _CompileOptions,
       captureList: CaptureList
     ) {
       self.options = options

Sources/_StringProcessing/Compiler.swift

@@ -16,7 +16,7 @@ class Compiler {
 
   // TODO: Or are these stored on the tree?
   var options = MatchingOptions()
-  private var compileOptions: CompileOptions = .default
+  private var compileOptions: _CompileOptions = .default
 
   init(ast: AST) {
     self.tree = ast.dslTree
@@ -26,7 +26,7 @@ class Compiler {
     self.tree = tree
   }
 
-  init(tree: DSLTree, compileOptions: CompileOptions) {
+  init(tree: DSLTree, compileOptions: _CompileOptions) {
     self.tree = tree
     self.compileOptions = compileOptions
   }
@@ -108,14 +108,14 @@ func _compileRegex(
 }
 
 @_spi(RegexBenchmark)
-public struct CompileOptions: OptionSet {
+public struct _CompileOptions: OptionSet {
   public let rawValue: Int
   public init(rawValue: Int) {
     self.rawValue = rawValue
   }
 
-  public static let disableOptimizations = CompileOptions(rawValue: 1 << 0)
-  public static let enableTracing = CompileOptions(rawValue: 1 << 1)
-  public static let enableMetrics = CompileOptions(rawValue: 1 << 2)
-  public static let `default`: CompileOptions = []
+  public static let disableOptimizations = _CompileOptions(rawValue: 1 << 0)
+  public static let enableTracing = _CompileOptions(rawValue: 1 << 1)
+  public static let enableMetrics = _CompileOptions(rawValue: 1 << 2)
+  public static let `default`: _CompileOptions = []
 }

Sources/_StringProcessing/Regex/Core.swift

@@ -82,7 +82,7 @@ extension Regex {
     let tree: DSLTree
 
     /// OptionSet of compiler options for testing purposes
-    fileprivate var compileOptions: CompileOptions = .default
+    fileprivate var compileOptions: _CompileOptions = .default
 
     private final class ProgramBox {
       let value: MEProgram
@@ -140,7 +140,7 @@ extension Regex {
 extension Regex {
   public enum _RegexInternalAction {
     case recompile
-    case addOptions(CompileOptions)
+    case addOptions(_CompileOptions)
   }
 
   /// Internal API for RegexBenchmark