Merge pull request #1151 from kimdv/kimdv/move-SyntaxEnum-to-codegen

Author: kimdv

CodeGeneration/Sources/SyntaxSupport/SyntaxBaseKinds.swift.gyb

@@ -18,7 +18,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-public let SYNTAX_BASE_KINDS: Set<String> = [
+public let SYNTAX_BASE_KINDS: [String] = [
 % for name in SYNTAX_BASE_KINDS:
   "${name}",
 % end

CodeGeneration/Sources/SyntaxSupport/gyb_generated/SyntaxBaseKinds.swift

@@ -12,7 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-public let SYNTAX_BASE_KINDS: Set<String> = [
+public let SYNTAX_BASE_KINDS: [String] = [
   "Decl",
   "Expr",
   "Pattern",

CodeGeneration/Sources/generate-swiftsyntax/GenerateSwiftSyntax.swift

@@ -29,6 +29,8 @@ struct GenerateSwiftSyntax: ParsableCommand {
         (miscFile, "Misc.swift"),
         (syntaxAnyVisitorFile, "SyntaxAnyVisitor.swift"),
         (syntaxBaseNodesFile, "SyntaxBaseNodes.swift"),
+        (syntaxEnumFile, "SyntaxEnum.swift"),
+        (syntaxKindFile, "SyntaxKind.swift")
       ],
       destination: URL(fileURLWithPath: generatedPath),
       verbose: verbose

CodeGeneration/Sources/generate-swiftsyntax/SyntaxEnumFile.swift

@@ -0,0 +1,50 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import SwiftSyntax
+import SwiftSyntaxBuilder
+import SyntaxSupport
+import Utils
+
+let syntaxEnumFile = SourceFile(leadingTrivia: .docLineComment(generateCopyrightHeader(for: "generate-swiftsyntax"))) {
+  EnumDecl("""
+    /// Enum to exhaustively switch over all different syntax nodes.
+    @frozen // FIXME: Not actually stable, works around a miscompile
+    public enum SyntaxEnum
+    """) {
+    EnumCaseDecl("case token(TokenSyntax)")
+    for node in NON_BASE_SYNTAX_NODES {
+      EnumCaseDecl("case \(raw: node.swiftSyntaxKind)(\(raw: node.name))")
+    }
+  }
+  
+  ExtensionDecl("""
+    public extension Syntax
+    """) {
+    FunctionDecl("""
+      /// Get an enum that can be used to exhaustively switch over all syntax nodes.
+      func `as`(_: SyntaxEnum.Type) -> SyntaxEnum
+      """) {
+      SwitchStmt(expression: Expr("raw.kind")) {
+        SwitchCase("case .token:") {
+          ReturnStmt("return .token(TokenSyntax(self)!)")
+        }
+        
+        for node in NON_BASE_SYNTAX_NODES {
+          SwitchCase("case .\(raw: node.swiftSyntaxKind):") {
+            ReturnStmt("return .\(raw: node.swiftSyntaxKind)(\(raw: node.name)(self)!)")
+          }
+        }
+      }
+    }
+  }
+}

CodeGeneration/Sources/generate-swiftsyntax/SyntaxKindFile.swift

@@ -0,0 +1,71 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import SwiftSyntax
+import SwiftSyntaxBuilder
+import SyntaxSupport
+import Utils
+
+let syntaxKindFile = SourceFile(leadingTrivia: .docLineComment(generateCopyrightHeader(for: "generate-swiftsyntax"))) {
+  EnumDecl("""
+    /// Enumerates the known kinds of Syntax represented in the Syntax tree.
+    @frozen // FIXME: Not actually stable, works around a miscompile
+    public enum SyntaxKind
+    """) {
+    EnumCaseDecl("case token")
+    for node in NON_BASE_SYNTAX_NODES {
+      EnumCaseDecl("case \(raw: node.swiftSyntaxKind)")
+    }
+    
+    VariableDecl(
+      modifiers: [DeclModifier(name: .public)],
+      name: IdentifierPattern("isSyntaxCollection"),
+      type: TypeAnnotation(
+        colon: .colon,
+        type: SimpleTypeIdentifier("Bool")
+      )
+    ) {
+      SwitchStmt(expression: Expr("self")) {
+        for node in SYNTAX_NODES where node.baseKind == "SyntaxCollection"{
+          SwitchCase("case .\(raw: node.swiftSyntaxKind):") {
+            ReturnStmt("return true")
+          }
+        }
+        
+        SwitchCase("default:") {
+          ReturnStmt("return false")
+        }
+      }
+    }
+    
+    VariableDecl(
+      modifiers: [DeclModifier(name: .public)],
+      name: IdentifierPattern("isMissing"),
+      type: TypeAnnotation(
+        colon: .colon,
+        type: SimpleTypeIdentifier("Bool")
+      )
+    ) {
+      SwitchStmt(expression: Expr("self")) {
+        for name in SYNTAX_BASE_KINDS where !["Syntax", "SyntaxCollection"].contains(name) {
+          SwitchCase("case .missing\(raw: name):") {
+            ReturnStmt("return true")
+          }
+        }
+        
+        SwitchCase("default:") {
+          ReturnStmt("return false")
+        }
+      }
+    }
+  }
+}

Package.swift

@@ -66,9 +66,7 @@ let package = Package(
         "Raw/RawSyntaxNodes.swift.gyb",
         "Raw/RawSyntaxValidation.swift.gyb",
         "SyntaxCollections.swift.gyb",
-        "SyntaxEnum.swift.gyb",
         "SyntaxFactory.swift.gyb",
-        "SyntaxKind.swift.gyb",
         "SyntaxNodes.swift.gyb.template",
         "SyntaxRewriter.swift.gyb",
         "SyntaxTransform.swift.gyb",

Sources/SwiftSyntax/CMakeLists.txt

@@ -35,9 +35,9 @@ add_swift_host_library(SwiftSyntax
   generated/SyntaxAnyVisitor.swift
   generated/SyntaxBaseNodes.swift
   gyb_generated/SyntaxCollections.swift
-  gyb_generated/SyntaxEnum.swift
+  generated/SyntaxEnum.swift
   gyb_generated/SyntaxFactory.swift
-  gyb_generated/SyntaxKind.swift
+  generated/SyntaxKind.swift
   gyb_generated/SyntaxRewriter.swift
   gyb_generated/SyntaxTraits.swift
   gyb_generated/SyntaxTransform.swift