Add compiler options for tracing and metrics

Author: rctcwyvrn

Sources/_StringProcessing/ByteCodeGen.swift

@@ -33,6 +33,8 @@ extension Compiler {
       self.options = options
       self.compileOptions = compileOptions
       self.builder.captureList = captureList
+      self.builder.enableTracing = compileOptions.contains(.enableTracing)
+      self.builder.enableMetrics = compileOptions.contains(.enableMetrics)
     }
   }
 }

Sources/_StringProcessing/Compiler.swift

@@ -107,10 +107,15 @@ func _compileRegex(
   return Executor(program: program)
 }
 
-extension Compiler {
-  struct CompileOptions: OptionSet {
-    let rawValue: Int
-    static let disableOptimizations = CompileOptions(rawValue: 1)
-    static let `default`: CompileOptions = []
+@_spi(RegexBenchmark)
+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 = []
 }

Sources/_StringProcessing/Engine/Engine.swift

@@ -23,6 +23,10 @@ struct Engine {
     get { program.enableTracing }
     set { program.enableTracing = newValue }
   }
+  var enableMetrics: Bool {
+    get { program.enableTracing }
+    set { program.enableMetrics = newValue }
+  }
 
   init(
     _ program: MEProgram,

Sources/_StringProcessing/Engine/MEBuilder.swift

@@ -14,6 +14,10 @@
 extension MEProgram {
   struct Builder {
     var instructions: [Instruction] = []
+    
+    // Tracing
+    var enableTracing = false
+    var enableMetrics = false
 
     var elements = TypedSetVector<Input.Element, _ElementRegister>()
     var sequences = TypedSetVector<[Input.Element], _SequenceRegister>()
@@ -378,6 +382,8 @@ extension MEProgram.Builder {
       staticTransformFunctions: transformFunctions,
       staticMatcherFunctions: matcherFunctions,
       registerInfo: regInfo,
+      enableTracing: enableTracing,
+      enableMetrics: enableMetrics,
       captureList: captureList,
       referencedCaptureOffsets: referencedCaptureOffsets,
       initialOptions: initialOptions)

Sources/_StringProcessing/Engine/MEProgram.swift

@@ -31,8 +31,9 @@ struct MEProgram {
 
   var registerInfo: RegisterInfo
 
-  var enableTracing: Bool = false
-
+  var enableTracing: Bool
+  var enableMetrics: Bool
+  
   let captureList: CaptureList
   let referencedCaptureOffsets: [ReferenceID: Int]
 

Sources/_StringProcessing/Regex/Core.swift

@@ -82,7 +82,7 @@ extension Regex {
     let tree: DSLTree
 
     /// OptionSet of compiler options for testing purposes
-    fileprivate var compileOptions: Compiler.CompileOptions = .default
+    fileprivate var compileOptions: CompileOptions = .default
 
     private final class ProgramBox {
       let value: MEProgram
@@ -138,16 +138,37 @@ extension Regex {
 @available(SwiftStdlib 5.7, *)
 @_spi(RegexBenchmark)
 extension Regex {
-  /// Compiles the stored DSLTree into bytecode and return if it was successful
-  /// For measuring compilation times
-  ///
-  /// Note: This bypasses the cached program that is normally used
-  public func _compileRegex() -> Bool {
+  public struct QueryResult {
+    
+  }
+  
+  public func _queryRegex() -> QueryResult {
+    QueryResult()
+  }
+  
+  public enum _RegexInternalAction {
+    case parse(String)
+    case recompile
+    case setOptions(CompileOptions)
+  }
+  
+  /// Internal API for RegexBenchmark
+  /// Forces the regex to perform the given action, returning if it was successful
+  public mutating func _forceAction(_ action: _RegexInternalAction) -> Bool {
     do {
-      let _ = try Compiler(
-        tree: program.tree,
-        compileOptions: program.compileOptions).emit()
-      return true
+      switch action {
+      case .setOptions(let opts):
+        _setCompilerOptionsForTesting(opts)
+        return true
+      case .parse(let pattern):
+        let _ = try parse(pattern, .traditional)
+        return true
+      case .recompile:
+        let _ = try Compiler(
+          tree: program.tree,
+          compileOptions: program.compileOptions).emit()
+        return true
+      }
     } catch {
       return false
     }
@@ -156,7 +177,9 @@ extension Regex {
 
 @available(SwiftStdlib 5.7, *)
 extension Regex {
-  internal mutating func _setCompilerOptionsForTesting(_ opts: Compiler.CompileOptions) {
+  internal mutating func _setCompilerOptionsForTesting(
+    _ opts: CompileOptions
+  ) {
     program.compileOptions = opts
     program._loweredProgramStorage = nil
   }