Rename YieldStmtArgument*

I found a better name for these nodes.

Author: ahoppen

CodeGeneration/Sources/SyntaxSupport/ExprNodes.swift

@@ -1921,7 +1921,7 @@ public let EXPR_NODES: [Node] = [
   ),
 
   Node(
-    kind: .yieldStmtArgument,
+    kind: .yieldedExpression,
     base: .syntax,
     nameForDiagnostics: nil,
     children: [
@@ -1938,10 +1938,10 @@ public let EXPR_NODES: [Node] = [
   ),
 
   Node(
-    kind: .yieldStmtArgumentList,
+    kind: .yieldedExpressionList,
     base: .syntaxCollection,
     nameForDiagnostics: "yield list",
-    elementChoices: [.yieldStmtArgument]
+    elementChoices: [.yieldedExpression]
   ),
 
 ]

CodeGeneration/Sources/SyntaxSupport/StmtNodes.swift

@@ -566,7 +566,7 @@ public let STMT_NODES: [Node] = [
   ),
 
   Node(
-    kind: .yieldStmtArgumentClause,
+    kind: .yieldedExpressionsClause,
     base: .syntax,
     nameForDiagnostics: nil,
     children: [
@@ -577,7 +577,7 @@ public let STMT_NODES: [Node] = [
       Child(
         name: "Elements",
         deprecatedName: "ElementList",
-        kind: .collection(kind: .yieldStmtArgumentList, collectionElementName: "Element")
+        kind: .collection(kind: .yieldedExpressionList, collectionElementName: "Element")
       ),
       Child(
         name: "RightParen",
@@ -601,11 +601,13 @@ public let STMT_NODES: [Node] = [
         deprecatedName: "Yields",
         kind: .nodeChoices(choices: [
           Child(
-            name: "YieldList",
-            kind: .node(kind: .yieldStmtArgumentClause)
+            name: "Multiple",
+            deprecatedName: "YieldList",
+            kind: .node(kind: .yieldedExpressionsClause)
           ),
           Child(
-            name: "SimpleYield",
+            name: "Single",
+            deprecatedName: "SimpleYield",
             kind: .node(kind: .expr)
           ),
         ])

CodeGeneration/Sources/SyntaxSupport/SyntaxNodeKind.swift

@@ -300,9 +300,9 @@ public enum SyntaxNodeKind: String, CaseIterable {
   case whileStmt
   case wildcardPattern
   case yieldStmt
-  case yieldStmtArgument
-  case yieldStmtArgumentClause
-  case yieldStmtArgumentList
+  case yieldedExpression
+  case yieldedExpressionsClause
+  case yieldedExpressionList
 
   // Nodes that have special handling throughout the codebase
 
@@ -436,9 +436,9 @@ public enum SyntaxNodeKind: String, CaseIterable {
     case .switchCaseItemList: return "caseItemList"
     case .typeAliasDecl: return "typealiasDecl"
     case .unavailableFromAsyncAttributeArguments: return "unavailableFromAsyncArguments"
-    case .yieldStmtArgument: return "yieldExprListElement"
-    case .yieldStmtArgumentClause: return "yieldList"
-    case .yieldStmtArgumentList: return "yieldExprList"
+    case .yieldedExpression: return "yieldExprListElement"
+    case .yieldedExpressionsClause: return "yieldList"
+    case .yieldedExpressionList: return "yieldExprList"
     default: return nil
     }
   }

CodeGeneration/Tests/ValidateSyntaxNodes/ValidateSyntaxNodes.swift

@@ -537,7 +537,7 @@ class ValidateSyntaxNodes: XCTestCase {
         ValidationFailure(node: .precedenceGroupDecl, message: "could conform to trait 'Braced' but does not"),
         ValidationFailure(node: .precedenceGroupName, message: "could conform to trait 'NamedDecl' but does not"),
         ValidationFailure(node: .primaryAssociatedType, message: "could conform to trait 'NamedDecl' but does not"),
-        ValidationFailure(node: .yieldStmtArgumentClause, message: "could conform to trait 'Parenthesized' but does not"),
+        ValidationFailure(node: .yieldedExpressionsClause, message: "could conform to trait 'Parenthesized' but does not"),
       ]
     )
   }

Sources/SwiftParser/Statements.swift

@@ -680,16 +680,16 @@ extension Parser {
 
     let yieldedExpressions: RawYieldStmtSyntax.YieldedExpressions
     if let lparen = self.consume(if: .leftParen) {
-      let exprList: RawYieldStmtArgumentListSyntax
+      let exprList: RawYieldedExpressionListSyntax
       do {
         var keepGoing = true
-        var elementList = [RawYieldStmtArgumentSyntax]()
+        var elementList = [RawYieldedExpressionSyntax]()
         var loopProgress = LoopProgressCondition()
         while !self.at(.endOfFile, .rightParen) && keepGoing && self.hasProgressed(&loopProgress) {
           let expr = self.parseExpression()
           let comma = self.consume(if: .comma)
           elementList.append(
-            RawYieldStmtArgumentSyntax(
+            RawYieldedExpressionSyntax(
               expression: expr,
               comma: comma,
               arena: self.arena
@@ -698,11 +698,11 @@ extension Parser {
 
           keepGoing = (comma != nil)
         }
-        exprList = RawYieldStmtArgumentListSyntax(elements: elementList, arena: self.arena)
+        exprList = RawYieldedExpressionListSyntax(elements: elementList, arena: self.arena)
       }
       let (unexpectedBeforeRParen, rparen) = self.expect(.rightParen)
-      yieldedExpressions = .yieldList(
-        RawYieldStmtArgumentClauseSyntax(
+      yieldedExpressions = .multiple(
+        RawYieldedExpressionsClauseSyntax(
           leftParen: lparen,
           elements: exprList,
           unexpectedBeforeRParen,
@@ -711,7 +711,7 @@ extension Parser {
         )
       )
     } else {
-      yieldedExpressions = .simpleYield(self.parseExpression())
+      yieldedExpressions = .single(self.parseExpression())
     }
 
     return RawYieldStmtSyntax(

Sources/SwiftParserDiagnostics/generated/SyntaxKindNameForDiagnostics.swift

@@ -403,10 +403,10 @@ extension SyntaxKind {
       return "'while' statement"
     case .wildcardPattern:
       return "wildcard pattern"
-    case .yieldStmtArgumentList:
-      return "yield list"
     case .yieldStmt:
       return "'yield' statement"
+    case .yieldedExpressionList:
+      return "yield list"
     default:
       return nil
     }

Sources/SwiftSyntax/Documentation.docc/generated/SwiftSyntax.md

@@ -300,8 +300,8 @@ These articles are intended for developers wishing to contribute to SwiftSyntax
 - <doc:SwiftSyntax/UnexpectedNodesSyntax>
 - <doc:SwiftSyntax/VersionComponentListSyntax>
 - <doc:SwiftSyntax/VersionComponentSyntax>
-- <doc:SwiftSyntax/YieldStmtArgumentListSyntax>
-- <doc:SwiftSyntax/YieldStmtArgumentSyntax>
+- <doc:SwiftSyntax/YieldedExpressionListSyntax>
+- <doc:SwiftSyntax/YieldedExpressionSyntax>
 
 ### Miscellaneous Syntax
 
@@ -368,7 +368,7 @@ These articles are intended for developers wishing to contribute to SwiftSyntax
 - <doc:SwiftSyntax/UnderscorePrivateAttributeArgumentsSyntax>
 - <doc:SwiftSyntax/VersionTupleSyntax>
 - <doc:SwiftSyntax/WhereClauseSyntax>
-- <doc:SwiftSyntax/YieldStmtArgumentClauseSyntax>
+- <doc:SwiftSyntax/YieldedExpressionsClauseSyntax>
 
 ### Traits
 

Sources/SwiftSyntax/generated/ChildNameForKeyPath.swift

@@ -3459,30 +3459,6 @@ public func childName(_ keyPath: AnyKeyPath) -> String? {
     return "typeAnnotation"
   case \WildcardPatternSyntax.unexpectedAfterTypeAnnotation:
     return "unexpectedAfterTypeAnnotation"
-  case \YieldStmtArgumentClauseSyntax.unexpectedBeforeLeftParen:
-    return "unexpectedBeforeLeftParen"
-  case \YieldStmtArgumentClauseSyntax.leftParen:
-    return "leftParen"
-  case \YieldStmtArgumentClauseSyntax.unexpectedBetweenLeftParenAndElements:
-    return "unexpectedBetweenLeftParenAndElements"
-  case \YieldStmtArgumentClauseSyntax.elements:
-    return "elements"
-  case \YieldStmtArgumentClauseSyntax.unexpectedBetweenElementsAndRightParen:
-    return "unexpectedBetweenElementsAndRightParen"
-  case \YieldStmtArgumentClauseSyntax.rightParen:
-    return "rightParen"
-  case \YieldStmtArgumentClauseSyntax.unexpectedAfterRightParen:
-    return "unexpectedAfterRightParen"
-  case \YieldStmtArgumentSyntax.unexpectedBeforeExpression:
-    return "unexpectedBeforeExpression"
-  case \YieldStmtArgumentSyntax.expression:
-    return "expression"
-  case \YieldStmtArgumentSyntax.unexpectedBetweenExpressionAndComma:
-    return "unexpectedBetweenExpressionAndComma"
-  case \YieldStmtArgumentSyntax.comma:
-    return "comma"
-  case \YieldStmtArgumentSyntax.unexpectedAfterComma:
-    return "unexpectedAfterComma"
   case \YieldStmtSyntax.unexpectedBeforeYieldKeyword:
     return "unexpectedBeforeYieldKeyword"
   case \YieldStmtSyntax.yieldKeyword:
@@ -3493,6 +3469,30 @@ public func childName(_ keyPath: AnyKeyPath) -> String? {
     return "yieldedExpressions"
   case \YieldStmtSyntax.unexpectedAfterYieldedExpressions:
     return "unexpectedAfterYieldedExpressions"
+  case \YieldedExpressionSyntax.unexpectedBeforeExpression:
+    return "unexpectedBeforeExpression"
+  case \YieldedExpressionSyntax.expression:
+    return "expression"
+  case \YieldedExpressionSyntax.unexpectedBetweenExpressionAndComma:
+    return "unexpectedBetweenExpressionAndComma"
+  case \YieldedExpressionSyntax.comma:
+    return "comma"
+  case \YieldedExpressionSyntax.unexpectedAfterComma:
+    return "unexpectedAfterComma"
+  case \YieldedExpressionsClauseSyntax.unexpectedBeforeLeftParen:
+    return "unexpectedBeforeLeftParen"
+  case \YieldedExpressionsClauseSyntax.leftParen:
+    return "leftParen"
+  case \YieldedExpressionsClauseSyntax.unexpectedBetweenLeftParenAndElements:
+    return "unexpectedBetweenLeftParenAndElements"
+  case \YieldedExpressionsClauseSyntax.elements:
+    return "elements"
+  case \YieldedExpressionsClauseSyntax.unexpectedBetweenElementsAndRightParen:
+    return "unexpectedBetweenElementsAndRightParen"
+  case \YieldedExpressionsClauseSyntax.rightParen:
+    return "rightParen"
+  case \YieldedExpressionsClauseSyntax.unexpectedAfterRightParen:
+    return "unexpectedAfterRightParen"
   default:
     return nil
   }

Sources/SwiftSyntax/generated/RenamedChildrenCompatibility.swift

@@ -8594,115 +8594,115 @@ extension WhereClauseSyntax {
   }
 }
 
-extension YieldStmtArgumentClauseSyntax {
-  @available(*, deprecated, renamed: "unexpectedBetweenLeftParenAndElements")
-  public var unexpectedBetweenLeftParenAndElementList: UnexpectedNodesSyntax? {
+extension YieldStmtSyntax {
+  @available(*, deprecated, renamed: "unexpectedBetweenYieldKeywordAndYieldedExpressions")
+  public var unexpectedBetweenYieldKeywordAndYields: UnexpectedNodesSyntax? {
     get {
-      return unexpectedBetweenLeftParenAndElements
+      return unexpectedBetweenYieldKeywordAndYieldedExpressions
     }
     set {
-      unexpectedBetweenLeftParenAndElements = newValue
+      unexpectedBetweenYieldKeywordAndYieldedExpressions = newValue
     }
   }
 
-  @available(*, deprecated, renamed: "elements")
-  public var elementList: YieldStmtArgumentListSyntax {
+  @available(*, deprecated, renamed: "yieldedExpressions")
+  public var yields: YieldedExpressions {
     get {
-      return elements
+      return yieldedExpressions
     }
     set {
-      elements = newValue
+      yieldedExpressions = newValue
     }
   }
 
-  @available(*, deprecated, renamed: "unexpectedBetweenElementsAndRightParen")
-  public var unexpectedBetweenElementListAndRightParen: UnexpectedNodesSyntax? {
+  @available(*, deprecated, renamed: "unexpectedAfterYieldedExpressions")
+  public var unexpectedAfterYields: UnexpectedNodesSyntax? {
     get {
-      return unexpectedBetweenElementsAndRightParen
+      return unexpectedAfterYieldedExpressions
     }
     set {
-      unexpectedBetweenElementsAndRightParen = newValue
+      unexpectedAfterYieldedExpressions = newValue
     }
   }
 
-  @available(*, deprecated, message: "Use an initializer with elements argument(s).")
+  @available(*, deprecated, message: "Use an initializer with yieldedExpressions argument(s).")
   @_disfavoredOverload
   public init(
       leadingTrivia: Trivia? = nil,
-      _ unexpectedBeforeLeftParen: UnexpectedNodesSyntax? = nil,
-      leftParen: TokenSyntax = .leftParenToken(),
-      _ unexpectedBetweenLeftParenAndElementList: UnexpectedNodesSyntax? = nil,
-      elementList: YieldStmtArgumentListSyntax,
-      _ unexpectedBetweenElementListAndRightParen: UnexpectedNodesSyntax? = nil,
-      rightParen: TokenSyntax = .rightParenToken(),
-      _ unexpectedAfterRightParen: UnexpectedNodesSyntax? = nil,
+      _ unexpectedBeforeYieldKeyword: UnexpectedNodesSyntax? = nil,
+      yieldKeyword: TokenSyntax = .keyword(.yield),
+      _ unexpectedBetweenYieldKeywordAndYields: UnexpectedNodesSyntax? = nil,
+      yields: YieldedExpressions,
+      _ unexpectedAfterYields: UnexpectedNodesSyntax? = nil,
       trailingTrivia: Trivia? = nil
 
   ) {
     self.init(
         leadingTrivia: leadingTrivia, 
-        unexpectedBeforeLeftParen, 
-        leftParen: leftParen, 
-        unexpectedBetweenLeftParenAndElementList, 
-        elements: elementList, 
-        unexpectedBetweenElementListAndRightParen, 
-        rightParen: rightParen, 
-        unexpectedAfterRightParen, 
+        unexpectedBeforeYieldKeyword, 
+        yieldKeyword: yieldKeyword, 
+        unexpectedBetweenYieldKeywordAndYields, 
+        yieldedExpressions: yields, 
+        unexpectedAfterYields, 
         trailingTrivia: trailingTrivia
       )
   }
 }
 
-extension YieldStmtSyntax {
-  @available(*, deprecated, renamed: "unexpectedBetweenYieldKeywordAndYieldedExpressions")
-  public var unexpectedBetweenYieldKeywordAndYields: UnexpectedNodesSyntax? {
+extension YieldedExpressionsClauseSyntax {
+  @available(*, deprecated, renamed: "unexpectedBetweenLeftParenAndElements")
+  public var unexpectedBetweenLeftParenAndElementList: UnexpectedNodesSyntax? {
     get {
-      return unexpectedBetweenYieldKeywordAndYieldedExpressions
+      return unexpectedBetweenLeftParenAndElements
     }
     set {
-      unexpectedBetweenYieldKeywordAndYieldedExpressions = newValue
+      unexpectedBetweenLeftParenAndElements = newValue
     }
   }
 
-  @available(*, deprecated, renamed: "yieldedExpressions")
-  public var yields: YieldedExpressions {
+  @available(*, deprecated, renamed: "elements")
+  public var elementList: YieldedExpressionListSyntax {
     get {
-      return yieldedExpressions
+      return elements
     }
     set {
-      yieldedExpressions = newValue
+      elements = newValue
     }
   }
 
-  @available(*, deprecated, renamed: "unexpectedAfterYieldedExpressions")
-  public var unexpectedAfterYields: UnexpectedNodesSyntax? {
+  @available(*, deprecated, renamed: "unexpectedBetweenElementsAndRightParen")
+  public var unexpectedBetweenElementListAndRightParen: UnexpectedNodesSyntax? {
     get {
-      return unexpectedAfterYieldedExpressions
+      return unexpectedBetweenElementsAndRightParen
     }
     set {
-      unexpectedAfterYieldedExpressions = newValue
+      unexpectedBetweenElementsAndRightParen = newValue
     }
   }
 
-  @available(*, deprecated, message: "Use an initializer with yieldedExpressions argument(s).")
+  @available(*, deprecated, message: "Use an initializer with elements argument(s).")
   @_disfavoredOverload
   public init(
       leadingTrivia: Trivia? = nil,
-      _ unexpectedBeforeYieldKeyword: UnexpectedNodesSyntax? = nil,
-      yieldKeyword: TokenSyntax = .keyword(.yield),
-      _ unexpectedBetweenYieldKeywordAndYields: UnexpectedNodesSyntax? = nil,
-      yields: YieldedExpressions,
-      _ unexpectedAfterYields: UnexpectedNodesSyntax? = nil,
+      _ unexpectedBeforeLeftParen: UnexpectedNodesSyntax? = nil,
+      leftParen: TokenSyntax = .leftParenToken(),
+      _ unexpectedBetweenLeftParenAndElementList: UnexpectedNodesSyntax? = nil,
+      elementList: YieldedExpressionListSyntax,
+      _ unexpectedBetweenElementListAndRightParen: UnexpectedNodesSyntax? = nil,
+      rightParen: TokenSyntax = .rightParenToken(),
+      _ unexpectedAfterRightParen: UnexpectedNodesSyntax? = nil,
       trailingTrivia: Trivia? = nil
 
   ) {
     self.init(
         leadingTrivia: leadingTrivia, 
-        unexpectedBeforeYieldKeyword, 
-        yieldKeyword: yieldKeyword, 
-        unexpectedBetweenYieldKeywordAndYields, 
-        yieldedExpressions: yields, 
-        unexpectedAfterYields, 
+        unexpectedBeforeLeftParen, 
+        leftParen: leftParen, 
+        unexpectedBetweenLeftParenAndElementList, 
+        elements: elementList, 
+        unexpectedBetweenElementListAndRightParen, 
+        rightParen: rightParen, 
+        unexpectedAfterRightParen, 
         trailingTrivia: trailingTrivia
       )
   }