Fix tracing

Author: rctcwyvrn

Sources/RegexBenchmark/Benchmark.swift

@@ -25,10 +25,10 @@ struct Benchmark: RegexBenchmark {
   }
 
   mutating func enableTracing() {
-    let _ = regex._forceAction(.setOptions(.enableTracing))
+    let _ = regex._forceAction(.addOptions(.enableTracing))
   }
   mutating func enableMetrics() {
-    let _ = regex._forceAction(.setOptions(.enableMetrics))
+    let _ = regex._forceAction(.addOptions([.enableMetrics, .disableOptimizations]))
   }
 
   func run() {
@@ -76,10 +76,10 @@ struct InputListBenchmark: RegexBenchmark {
     blackHole(regex._forceAction(.recompile))
   }
   mutating func enableTracing() {
-    let _ = regex._forceAction(.setOptions(.enableTracing))
+    let _ = regex._forceAction(.addOptions(.enableTracing))
   }
   mutating func enableMetrics() {
-    let _ = regex._forceAction(.setOptions(.enableMetrics))
+    let _ = regex._forceAction(.addOptions(.enableMetrics))
   }
 
   func run() {

Sources/_StringProcessing/Engine/Consume.swift

@@ -30,7 +30,7 @@ extension Engine {
     subjectBounds: Range<String.Index>,
     searchBounds: Range<String.Index>
   ) -> Processor {
-    Processor(
+    return Processor(
       program: program,
       input: input,
       subjectBounds: subjectBounds,

Sources/_StringProcessing/Engine/Engine.swift

@@ -13,29 +13,16 @@
 // But, we can play around with this.
 struct Engine {
 
-  var program: MEProgram
+  let program: MEProgram
 
   // TODO: Pre-allocated register banks
 
   var instructions: InstructionList<Instruction> { program.instructions }
 
-  var enableTracing: Bool {
-    get { program.enableTracing }
-    set { program.enableTracing = newValue }
-  }
-  var enableMetrics: Bool {
-    get { program.enableMetrics }
-    set { program.enableMetrics = newValue }
-  }
+  var enableTracing: Bool { program.enableTracing }
+  var enableMetrics: Bool { program.enableMetrics }
 
-  init(
-    _ program: MEProgram,
-    enableTracing: Bool? = nil
-  ) {
-    var program = program
-    if let t = enableTracing {
-      program.enableTracing = t
-    }
+  init(_ program: MEProgram) {
     self.program = program
   }
 }

Sources/_StringProcessing/Engine/Processor.swift

@@ -110,7 +110,6 @@ extension Processor {
     isTracingEnabled: Bool,
     shouldMeasureMetrics: Bool
   ) {
-    // print("metrics? \(shouldMeasureMetrics) tracing? \(isTracingEnabled)")
     self.controller = Controller(pc: 0)
     self.instructions = program.instructions
     self.input = input

Sources/_StringProcessing/Engine/Tracing.swift

@@ -76,9 +76,9 @@ extension Instruction: CustomStringConvertible {
     case .matchScalar:
       let (scalar, caseInsensitive, boundaryCheck) = payload.scalarPayload
       if caseInsensitive {
-        return "matchScalarCaseInsensitive \(scalar) boundaryCheck: \(boundaryCheck)"
+        return "matchScalarCaseInsensitive '\(scalar)' boundaryCheck: \(boundaryCheck)"
       } else {
-        return "matchScalar \(scalar) boundaryCheck: \(boundaryCheck)"
+        return "matchScalar '\(scalar)' boundaryCheck: \(boundaryCheck)"
       }
     case .moveCurrentPosition:
       let reg = payload.position

Sources/_StringProcessing/Executor.swift

@@ -15,8 +15,8 @@ struct Executor {
   // TODO: consider let, for now lets us toggle tracing
   var engine: Engine
 
-  init(program: MEProgram, enablesTracing: Bool = false) {
-    self.engine = Engine(program, enableTracing: enablesTracing)
+  init(program: MEProgram) {
+    self.engine = Engine(program)
   }
 
   @available(SwiftStdlib 5.7, *)

Sources/_StringProcessing/Regex/Core.swift

@@ -149,16 +149,17 @@ extension Regex {
   public enum _RegexInternalAction {
     case parse(String)
     case recompile
-    case setOptions(CompileOptions)
+    case addOptions(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 {
       switch action {
-      case .setOptions(let opts):
-        _setCompilerOptionsForTesting(opts)
+      case .addOptions(let opts):
+        program.compileOptions.insert(opts)
+        program._loweredProgramStorage = nil
         return true
       case .parse(let pattern):
         let _ = try parse(pattern, .traditional)
@@ -174,13 +175,3 @@ extension Regex {
     }
   }
 }
-
-@available(SwiftStdlib 5.7, *)
-extension Regex {
-  internal mutating func _setCompilerOptionsForTesting(
-    _ opts: CompileOptions
-  ) {
-    program.compileOptions = opts
-    program._loweredProgramStorage = nil
-  }
-}

Sources/_StringProcessing/Utility/Traced.swift

@@ -80,17 +80,21 @@ extension TracedProcessor {
   }
 
   func formatInput() -> String {
+    let distanceFromStart = input.distance(
+      from: input.startIndex,
+      to: currentPosition)
+
     // Cut a reasonably sized substring from the input to print
     let start = input.index(
       currentPosition,
-      offsetBy: -10,
+      offsetBy: -30,
       limitedBy: input.startIndex) ?? input.startIndex
     let end = input.index(
       currentPosition,
-      offsetBy: 10,
+      offsetBy: 30,
       limitedBy: input.endIndex) ?? input.endIndex
-    let input = input[start...end]
-  
+    let input = input[start..<end]
+    
     // String override for printing sub-character information.
     if !input.indices.contains(currentPosition) {
       // Format unicode scalars as:
@@ -111,6 +115,7 @@ extension TracedProcessor {
                     .joined())
                  \(String(repeating: ".", count: matchedHighlightWidth))\
           ^\(String(repeating: "~", count: nextHighlightWidth - 1))
+          position: \(distanceFromStart)
           """
       }
       if let string = input as? String {
@@ -119,10 +124,11 @@ extension TracedProcessor {
         return _format(substring)
       }
     }
-    let dist = input.distance(from: input.startIndex, to: currentPosition)
+    let dist = input.distance(from: start, to: currentPosition)
     return """
       input: \(input)
              \(String(repeating: "~", count: dist))^
+      position: \(distanceFromStart)
       """
   }
 

Tests/RegexTests/MatchTests.swift

@@ -32,7 +32,7 @@ func _firstMatch(
   let result = try regex.firstMatch(in: input)
 
   if validateOptimizations {
-    regex._setCompilerOptionsForTesting(.disableOptimizations)
+    assert(regex._forceAction(.addOptions(.disableOptimizations)))
     let unoptResult = try regex.firstMatch(in: input)
     if result != nil && unoptResult == nil {
       throw MatchError("match not found for unoptimized \(regexStr) in \(input)")