Merge pull request #2351 from rintaro/syntaxenum-per-base

Add SyntaxEnum per base syntax kind

Author: rintaro

CodeGeneration/Sources/generate-swift-syntax/templates/swiftsyntax/SyntaxEnumFile.swift

@@ -57,4 +57,50 @@ let syntaxEnumFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
       }
     }
   }
+
+  for base in SYNTAX_NODES where base.kind.isBase {
+    let baseKind = base.kind
+    let baseName = baseKind.rawValue.withFirstCharacterUppercased;
+    let enumType: TypeSyntax = "\(raw: baseName)SyntaxEnum"
+
+    try! EnumDeclSyntax(
+      """
+      /// Enum to exhaustively switch over all different \(raw: baseName) syntax nodes.
+      public enum \(enumType)
+      """
+    ) {
+      for node in NON_BASE_SYNTAX_NODES where node.base == baseKind {
+        DeclSyntax(
+          """
+          \(node.apiAttributes())\
+          case \(node.varOrCaseName)(\(node.kind.syntaxType))
+          """
+        )
+      }
+    }
+
+    try! ExtensionDeclSyntax(
+      """
+      public extension \(baseKind.syntaxType)
+      """
+    ) {
+      try FunctionDeclSyntax(
+        """
+        /// Get an enum that can be used to exhaustively switch over all \(raw: baseName) syntax nodes.
+        func `as`(_: \(enumType).Type) -> \(enumType)
+        """
+      ) {
+        try SwitchExprSyntax("switch raw.kind") {
+          for node in NON_BASE_SYNTAX_NODES where node.base == baseKind {
+            SwitchCaseSyntax("case .\(node.varOrCaseName):") {
+              StmtSyntax("return .\(node.varOrCaseName)(\(node.kind.syntaxType)(self)!)")
+            }
+          }
+          SwitchCaseSyntax("default:") {
+            ExprSyntax(#"preconditionFailure("unknown \#(raw: baseName) syntax kind")"#)
+          }
+        }
+      }
+    }
+  }
 }

Release Notes/511.md

@@ -16,6 +16,10 @@
   - Issue: https://github.com/apple/swift-syntax/issues/2015
   - Pull Request: https://github.com/apple/swift-syntax/pull/2021
 
+- `DeclSyntaxEnum`, `StmtSyntaxEnum`, `ExprSyntaxEnum`, `TypeSyntaxEnum`, and `PatternSyntaxEnum`
+  - Description: Enum to exhaustively switch over all different syntax nodes of each base type.
+  - Pull Request: https://github.com/apple/swift-syntax/pull/2351
+
 ## API Behavior Changes
 
 ## Deprecations