Rename DSLTree.alternation to DSLTree.orderedChoice

Author: milseman

Sources/_StringProcessing/ByteCodeGen.swift

@@ -557,7 +557,7 @@ extension Compiler.ByteCodeGen {
   mutating func emitNode(_ node: DSLTree.Node) throws {
     switch node {
 
-    case let .alternation(children):
+    case let .orderedChoice(children):
       try emitAlternation(children)
 
     case let .concatenation(children):

Sources/_StringProcessing/ConsumerInterface.swift

@@ -36,7 +36,7 @@ extension DSLTree.Node {
     case let .convertedRegexLiteral(n, _):
       return try n.generateConsumer(opts)
 
-    case .alternation, .conditional, .concatenation, .group,
+    case .orderedChoice, .conditional, .concatenation, .group,
         .quantification, .trivia, .empty,
         .groupTransform, .absentFunction: return nil
 

Sources/_StringProcessing/PrintAsPattern.swift

@@ -73,7 +73,7 @@ extension PrettyPrinter {
 
     switch node {
 
-    case let .alternation(a):
+    case let .orderedChoice(a):
       printBlock("Alternation") { printer in
         a.forEach {
           printer.printAsPattern(convertedFromAST: $0)

Sources/_StringProcessing/RegexDSL/ASTConversion.swift

@@ -48,7 +48,7 @@ extension AST.Node {
       switch self {
       case let .alternation(v):
         let children = v.children.map(\.dslTreeNode)
-        return .alternation(children)
+        return .orderedChoice(children)
 
       case let .concatenation(v):
         // Coalesce adjacent children who can produce a

Sources/_StringProcessing/RegexDSL/DSLTree.swift

@@ -23,18 +23,28 @@ struct DSLTree {
 
 extension DSLTree {
   indirect enum Node: _TreeNode {
-    /// ... | ... | ...
-    case alternation([Node])
+    /// Try to match each node in order
+    ///
+    ///     ... | ... | ...
+    case orderedChoice([Node])
 
-    /// ... ...
+    /// Match each node in sequence
+    ///
+    ///     ... ...
     case concatenation([Node])
 
-    /// (...)
+    /// Match a subpattern / group
+    ///
+    ///      (...)
     case group(AST.Group.Kind, Node, ReferenceID? = nil)
 
-    /// (?(cond) true-branch | false-branch)
+    // TODO: Consider splitting off grouped conditions, or have
+    // our own kind
+
+    /// Match a choice of two nodes based on a condition
+    ///
+    ///     (?(cond) true-branch | false-branch)
     ///
-    /// TODO: Consider splitting off grouped conditions, or have our own kind
     case conditional(
       AST.Conditional.Condition.Kind, Node, Node)
 
@@ -157,7 +167,7 @@ extension DSLTree.Node {
   var children: [DSLTree.Node]? {
     switch self {
 
-    case let .alternation(v):   return v
+    case let .orderedChoice(v):   return v
     case let .concatenation(v): return v
 
     case let .convertedRegexLiteral(n, _):
@@ -253,7 +263,7 @@ extension DSLTree.Node {
     _ constructor: inout CaptureStructure.Constructor
   ) -> CaptureStructure {
     switch self {
-    case let .alternation(children):
+    case let .orderedChoice(children):
       return constructor.alternating(children)
 
     case let .concatenation(children):
@@ -319,10 +329,10 @@ extension DSLTree.Node {
   }
 
   func appendingAlternationCase(_ newNode: DSLTree.Node) -> DSLTree.Node {
-    if case .alternation(let components) = self {
-      return .alternation(components + [newNode])
+    if case .orderedChoice(let components) = self {
+      return .orderedChoice(components + [newNode])
     }
-    return .alternation([self, newNode])
+    return .orderedChoice([self, newNode])
   }
 }
 

Sources/_StringProcessing/RegexDSL/Variadics.swift

@@ -2220,47 +2220,47 @@ public func | <R0, W0, C0, C1, C2, C3, C4, C5, C6, C7, C8, R1, W1, C9>(lhs: R0,
 }
 extension AlternationBuilder {
   public static func buildBlock<R, W, C0>(_ regex: R) -> Regex<(W, C0?)> where R: RegexComponent, R.Match == (W, C0) {
-    .init(node: .alternation([regex.regex.root]))
+    .init(node: .orderedChoice([regex.regex.root]))
   }
 }
 extension AlternationBuilder {
   public static func buildBlock<R, W, C0, C1>(_ regex: R) -> Regex<(W, C0?, C1?)> where R: RegexComponent, R.Match == (W, C0, C1) {
-    .init(node: .alternation([regex.regex.root]))
+    .init(node: .orderedChoice([regex.regex.root]))
   }
 }
 extension AlternationBuilder {
   public static func buildBlock<R, W, C0, C1, C2>(_ regex: R) -> Regex<(W, C0?, C1?, C2?)> where R: RegexComponent, R.Match == (W, C0, C1, C2) {
-    .init(node: .alternation([regex.regex.root]))
+    .init(node: .orderedChoice([regex.regex.root]))
   }
 }
 extension AlternationBuilder {
   public static func buildBlock<R, W, C0, C1, C2, C3>(_ regex: R) -> Regex<(W, C0?, C1?, C2?, C3?)> where R: RegexComponent, R.Match == (W, C0, C1, C2, C3) {
-    .init(node: .alternation([regex.regex.root]))
+    .init(node: .orderedChoice([regex.regex.root]))
   }
 }
 extension AlternationBuilder {
   public static func buildBlock<R, W, C0, C1, C2, C3, C4>(_ regex: R) -> Regex<(W, C0?, C1?, C2?, C3?, C4?)> where R: RegexComponent, R.Match == (W, C0, C1, C2, C3, C4) {
-    .init(node: .alternation([regex.regex.root]))
+    .init(node: .orderedChoice([regex.regex.root]))
   }
 }
 extension AlternationBuilder {
   public static func buildBlock<R, W, C0, C1, C2, C3, C4, C5>(_ regex: R) -> Regex<(W, C0?, C1?, C2?, C3?, C4?, C5?)> where R: RegexComponent, R.Match == (W, C0, C1, C2, C3, C4, C5) {
-    .init(node: .alternation([regex.regex.root]))
+    .init(node: .orderedChoice([regex.regex.root]))
   }
 }
 extension AlternationBuilder {
   public static func buildBlock<R, W, C0, C1, C2, C3, C4, C5, C6>(_ regex: R) -> Regex<(W, C0?, C1?, C2?, C3?, C4?, C5?, C6?)> where R: RegexComponent, R.Match == (W, C0, C1, C2, C3, C4, C5, C6) {
-    .init(node: .alternation([regex.regex.root]))
+    .init(node: .orderedChoice([regex.regex.root]))
   }
 }
 extension AlternationBuilder {
   public static func buildBlock<R, W, C0, C1, C2, C3, C4, C5, C6, C7>(_ regex: R) -> Regex<(W, C0?, C1?, C2?, C3?, C4?, C5?, C6?, C7?)> where R: RegexComponent, R.Match == (W, C0, C1, C2, C3, C4, C5, C6, C7) {
-    .init(node: .alternation([regex.regex.root]))
+    .init(node: .orderedChoice([regex.regex.root]))
   }
 }
 extension AlternationBuilder {
   public static func buildBlock<R, W, C0, C1, C2, C3, C4, C5, C6, C7, C8>(_ regex: R) -> Regex<(W, C0?, C1?, C2?, C3?, C4?, C5?, C6?, C7?, C8?)> where R: RegexComponent, R.Match == (W, C0, C1, C2, C3, C4, C5, C6, C7, C8) {
-    .init(node: .alternation([regex.regex.root]))
+    .init(node: .orderedChoice([regex.regex.root]))
   }
 }
 // MARK: - Non-builder capture arity 0