Merge pull request #1425 from ahoppen/ahoppen/no-gyb

Remove remaining references to gyb

Author: ahoppen

CodeGeneration/Package.swift

@@ -23,6 +23,9 @@ let package = Package(
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
         "SyntaxSupport",
         "Utils",
+      ],
+      exclude: [
+        "templates/swiftsyntax/SwiftSyntaxDoccIndexTemplate.md"
       ]
     ),
     .target(

CodeGeneration/README.md

@@ -2,18 +2,18 @@
 
 This directory contains file to generate source code that is part of the SwiftSyntax package. If you are looking to generate Swift code yourself, you might be interested in [SwiftSyntaxBuilder](../Sources/SwiftSyntaxBuilder).
 
-SwiftSyntax currently uses two mechanisms to generate source code: gyb and SwiftSyntaxBuilder. Both can be run using 
-
-```bash
-./build-script.py generate-source-code --toolchain /path/to/toolchain.xctoolchain/usr
-```
+Some source code inside SwiftSyntax is generated using [SwiftSyntaxBuilder](../Sources/SwiftSyntaxBuilder), a Swift library whose purpose is to generate Swift code using Swift itself. This kind of code generation is performed by the Swift package defined in this directory.
 
-## `gyb`
+This directory is a standalone package that uses a pinned version of SwiftSyntaxBuilder. It is thus NOT using SwiftSyntaxBuilder of the parent directory. This guarantees that when `generate-swiftsyntax` is run, it can't break its own build.
 
-Files generated using `gyb` have a `.gyb` suffix. [ChangingSwiftSyntax.md](../Sources/SwiftSyntax/Documentation.docc/ChangingSwiftSyntax.md) contains documentation how `gyb` works. This directory contains the definitions that back most of gyb-generation in `gyb_syntax_support`.
+To re-generate the files after changing `CodeGeneration` run the `generate-swiftsyntax` 
+target of `CodeGeneration` and pass `path/to/swift-syntax/Sources` as the argument.
 
-## `SwiftSyntaxBuilder`
+On the command line, this would be
+```bash
+swift run --package-path CodeGeneration generate-swiftsyntax Sources
+```
 
-Some source code inside SwiftSyntax is generated using [SwiftSyntaxBuilder](../Sources/SwiftSyntaxBuilder), a Swift library whose purpose is to generate Swift code using Swift itself. This kind of code generation is performed by the Swift package defined in this directory.
+Or if you open the `CodeGeneration` package in Xcode, you can add the 
+`generate-swift syntax ../Sources` arguments using Product -> Scheme -> Edit Scheme…
 
-This directory is a standalone package that uses a pinned version of SwiftSyntaxBuilder. It is thus NOT using SwiftSyntaxBuilder of the parent directory. This guarantees that when `generate-swiftsyntaxbuilder` is run, it can't break its own build.

CodeGeneration/Sources/Utils/CopyrightHeader.swift

@@ -12,20 +12,19 @@
 
 import SwiftSyntax
 
-public func generateCopyrightHeader(for generator: String) -> Trivia {
-  return """
-    //// Automatically Generated by \(generator)
-    //// Do Not Edit Directly!
-    //===----------------------------------------------------------------------===//
-    //
-    // This source file is part of the Swift.org open source project
-    //
-    // Copyright (c) 2014 - 2023 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
-    //
-    //===----------------------------------------------------------------------===//
-    """ + .newlines(2)
-}
+public var copyrightHeader: Trivia =
+  """
+  //// Automatically generated by generate-swiftsyntax
+  //// Do not edit directly!
+  //===----------------------------------------------------------------------===//
+  //
+  // This source file is part of the Swift.org open source project
+  //
+  // Copyright (c) 2014 - 2023 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
+  //
+  //===----------------------------------------------------------------------===//
+  """ + .newlines(2)

CodeGeneration/Sources/Utils/SyntaxBuildableType.swift

@@ -26,7 +26,7 @@ public struct SyntaxBuildableType: Hashable {
   public init(syntaxKind: String, isOptional: Bool = false) {
     self.isOptional = isOptional
     if syntaxKind.hasSuffix("Token") {
-      // There are different token kinds but all of them are represented by `Token` in the Swift source (see `kind_to_type` in `gyb_syntax_support`).
+      // There are different token kinds but all of them are represented by `Token` in the Swift source (see `kindToType` in `SyntaxSupport/Utils.swift`).
       self.syntaxKind = "Token"
       self.tokenKind = syntaxKind
     } else {

CodeGeneration/Sources/Utils/Utils.swift

@@ -22,7 +22,7 @@ public func dedented(string: String) -> String {
 }
 
 /// Creates a single-line documentation string from indented
-/// documentation as written in `gyb_syntax_support`.
+/// documentation as written in `CodeGeneration`.
 public func flattened(indentedDocumentation: String) -> String {
   dedented(string: indentedDocumentation)
     .replacingOccurrences(of: "\n", with: "")

CodeGeneration/Sources/generate-swiftsyntax/GenerateSwiftSyntax.swift

@@ -74,6 +74,8 @@ struct GenerateSwiftSyntax: ParsableCommand {
   var verbose: Bool = false
 
   func run() throws {
+    let destination = URL(fileURLWithPath: self.destination).standardizedFileURL
+
     let fileSpecs: [GeneratedFileSpec] =
       [
         // SwiftBasicFormat
@@ -123,21 +125,23 @@ struct GenerateSwiftSyntax: ParsableCommand {
     let previouslyGeneratedFilesLock = NSLock()
     var previouslyGeneratedFiles = Set(
       modules.flatMap { (module) -> [URL] in
-        let generatedDir = URL(fileURLWithPath: destination)
+        let generatedDir =
+          destination
           .appendingPathComponent(module)
           .appendingPathComponent("generated")
         return FileManager.default
           .enumerator(at: generatedDir, includingPropertiesForKeys: nil)!
           .compactMap { $0 as? URL }
           .filter { !$0.hasDirectoryPath }
+          .map { $0.resolvingSymlinksInPath() }
       }
     )
 
     var errors: [Error] = []
     DispatchQueue.concurrentPerform(iterations: fileSpecs.count) { index in
       let fileSpec = fileSpecs[index]
       do {
-        var destination = URL(fileURLWithPath: destination)
+        var destination = destination
         for component in fileSpec.pathComponents {
           destination = destination.appendingPathComponent(component)
         }

CodeGeneration/Sources/generate-swiftsyntax/templates/basicformat/BasicFormatFile.swift

@@ -49,7 +49,7 @@ extension Child {
   }
 }
 
-let basicFormatFile = SourceFileSyntax(leadingTrivia: generateCopyrightHeader(for: "generate-swiftbasicformat")) {
+let basicFormatFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
   DeclSyntax("import SwiftSyntax")
 
   try! ClassDeclSyntax("open class BasicFormat: SyntaxRewriter") {

CodeGeneration/Sources/generate-swiftsyntax/templates/ideutils/SyntaxClassificationFile.swift

@@ -29,7 +29,7 @@ fileprivate var node_child_classifications: [ChildClassification] {
   return result
 }
 
-let syntaxClassificationFile = SourceFileSyntax(leadingTrivia: generateCopyrightHeader(for: "generate-ideutils")) {
+let syntaxClassificationFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
   DeclSyntax("@_spi(RawSyntax) import SwiftSyntax")
 
   try! EnumDeclSyntax("public enum SyntaxClassification") {

CodeGeneration/Sources/generate-swiftsyntax/templates/swiftparser/DeclarationModifierFile.swift

@@ -15,7 +15,7 @@ import SwiftSyntaxBuilder
 import SyntaxSupport
 import Utils
 
-let declarationModifierFile = SourceFileSyntax(leadingTrivia: generateCopyrightHeader(for: "generate-swiftparser")) {
+let declarationModifierFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
   DeclSyntax("@_spi(RawSyntax) import SwiftSyntax")
 
   try! EnumDeclSyntax("enum DeclarationModifier: TokenSpecSet") {

CodeGeneration/Sources/generate-swiftsyntax/templates/swiftparser/ParserEntryFile.swift

@@ -15,7 +15,7 @@ import SwiftSyntaxBuilder
 import SyntaxSupport
 import Utils
 
-let parserEntryFile = SourceFileSyntax(leadingTrivia: generateCopyrightHeader(for: "generate-swiftparser")) {
+let parserEntryFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
   DeclSyntax("@_spi(RawSyntax) import SwiftSyntax")
 
   try! ExtensionDeclSyntax("extension Parser") {