Merge pull request #1128 from kimdv/kimdv/add-codgen-for-swiftsyntax

Move swiftsyntax/Misc gyb to syntax generator

Author: kimdv

CodeGeneration/Package.swift

@@ -11,6 +11,7 @@ let package = Package(
     .executable(name: "generate-swiftbasicformat", targets: ["generate-swiftbasicformat"]),
     .executable(name: "generate-swiftideutils", targets: ["generate-swiftideutils"]),
     .executable(name: "generate-swiftparser", targets: ["generate-swiftparser"]),
+    .executable(name: "generate-swiftsyntax", targets: ["generate-swiftsyntax"]),
     .executable(name: "generate-swiftsyntaxbuilder", targets: ["generate-swiftsyntaxbuilder"]),
   ],
   dependencies: [
@@ -49,6 +50,16 @@ let package = Package(
       ]
     ),
     .executableTarget(
+      name: "generate-swiftsyntax",
+      dependencies: [
+        .product(name: "SwiftSyntax", package: "swift-syntax"),
+        .product(name: "SwiftSyntaxBuilder", package: "swift-syntax"),
+        .product(name: "ArgumentParser", package: "swift-argument-parser"),
+        "SyntaxSupport",
+        "Utils"
+      ]
+    ),
+      .executableTarget(
       name: "generate-swiftsyntaxbuilder",
       dependencies: [
         .product(name: "SwiftSyntax", package: "swift-syntax"),
@@ -62,6 +73,7 @@ let package = Package(
       name: "SyntaxSupport",
       exclude: [
         "gyb_helpers",
+        "AttributeKinds.swift.gyb",
         "AttributeNodes.swift.gyb",
         "AvailabilityNodes.swift.gyb",
         "BuilderInitializableTypes.swift.gyb",

CodeGeneration/Sources/SyntaxSupport/SyntaxNodes.swift

@@ -24,3 +24,5 @@ public let SYNTAX_NODES: [Node] = (COMMON_NODES
 public let SYNTAX_NODE_MAP: [String: Node] = Dictionary(
   uniqueKeysWithValues: SYNTAX_NODES.map { node in (node.syntaxKind, node) }
 )
+
+public let NON_BASE_SYNTAX_NODES = SYNTAX_NODES.filter { !$0.isBase }

CodeGeneration/Sources/generate-swiftsyntax/GenerateSwiftSyntax.swift

@@ -0,0 +1,35 @@
+//===----------------------------------------------------------------------===//
+//
+// 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 ArgumentParser
+import Foundation
+import SwiftSyntaxBuilder
+import Utils
+
+@main
+struct GenerateSwiftSyntax: ParsableCommand {
+  @Argument(help: "The path to the destination directory where the source files are to be generated")
+  var generatedPath: String
+
+  @Flag(help: "Enable verbose output")
+  var verbose: Bool = false
+
+  func run() throws {
+    try generateTemplates(
+      templates: [
+        (miscFile, "Misc.swift"),
+      ],
+      destination: URL(fileURLWithPath: generatedPath),
+      verbose: verbose
+    )
+  }
+}

CodeGeneration/Sources/generate-swiftsyntax/MiscFile.swift

@@ -0,0 +1,94 @@
+//===----------------------------------------------------------------------===//
+//
+// 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 miscFile = SourceFile {
+  ExtensionDecl("""
+    \(generateCopyrightHeader(for: "generate-swiftsyntax"))
+    extension Syntax
+    """) {
+    VariableDecl(
+      modifiers: [DeclModifierSyntax(name: Token.public), DeclModifier(name: Token.static)],
+      name: IdentifierPattern("structure"),
+      type: TypeAnnotation(
+        colon: .colon,
+        type: SimpleTypeIdentifier("SyntaxNodeStructure")
+      )
+    ) {
+      ReturnStmt(
+        expression: FunctionCallExpr(callee: MemberAccessExpr(".choices")) {
+          TupleExprElement(
+            expression: ArrayExprSyntax {
+              ArrayElement(
+                expression: FunctionCallExpr("\n.node(TokenSyntax.self)"),
+                trailingComma: Token.comma)
+              for node in NON_BASE_SYNTAX_NODES {
+                ArrayElement(
+                  expression: FunctionCallExpr("\n.node(\(raw: node.name).self)"),
+                  trailingComma: Token.comma)
+              }
+            })
+        }
+      )
+    }
+  }
+  
+  ExtensionDecl("extension SyntaxKind") {
+    VariableDecl(
+      modifiers: [DeclModifier(name: Token.public)],
+      name: IdentifierPattern("syntaxNodeType"),
+      type: TypeAnnotation(
+        colon: .colon,
+        type: MemberTypeIdentifier("SyntaxProtocol.Type")
+      )
+    ) {
+      SwitchStmt(expression: Expr("self")) {
+        SwitchCase("case .token:") {
+          ReturnStmt("return TokenSyntax.self")
+        }
+        for node in NON_BASE_SYNTAX_NODES {
+          SwitchCase("case .\(raw: node.swiftSyntaxKind):") {
+            ReturnStmt("return \(raw: node.name).self")
+          }
+        }
+      }
+    }
+    
+    VariableDecl(
+      modifiers: [DeclModifier(name: Token.public)],
+      name: IdentifierPattern("nameForDiagnostics"),
+      type: TypeAnnotation(
+        colon: .colon,
+        type: OptionalType("String?")
+      )
+    ) {
+      SwitchStmt(expression: Expr("self")) {
+        SwitchCase("case .token:") {
+          ReturnStmt(#"return "token""#)
+        }
+        for node in NON_BASE_SYNTAX_NODES {
+          SwitchCase("case .\(raw: node.swiftSyntaxKind):") {
+            if let nameForDiagnostics = node.nameForDiagnostics {
+              ReturnStmt("return \"\(raw: nameForDiagnostics)\"")
+            } else {
+              ReturnStmt("return nil")
+            }
+          }
+        }
+      }
+    }
+  }
+}

Package.swift

@@ -63,7 +63,6 @@ let package = Package(
       dependencies: [],
       exclude: [
         "CMakeLists.txt",
-        "Misc.swift.gyb",
         "Raw/RawSyntaxNodes.swift.gyb",
         "Raw/RawSyntaxValidation.swift.gyb",
         "SyntaxAnyVisitor.swift.gyb",

Sources/SwiftSyntax/CMakeLists.txt

@@ -31,7 +31,7 @@ add_swift_host_library(SwiftSyntax
   Raw/gyb_generated/RawSyntaxNodes.swift
   Raw/gyb_generated/RawSyntaxValidation.swift
 
-  gyb_generated/Misc.swift
+  generated/Misc.swift
   gyb_generated/SyntaxAnyVisitor.swift
   gyb_generated/SyntaxBaseNodes.swift
   gyb_generated/SyntaxCollections.swift