Merge branch 'main' into fix/document-tutorial

Author: KaitoMuraoka

CodeGeneration/Sources/SyntaxSupport/CommonNodes.swift

@@ -56,6 +56,7 @@ public let COMMON_NODES: [Node] = [
     kind: .codeBlock,
     base: .syntax,
     nameForDiagnostics: "code block",
+    parserFunction: "parseCodeBlock",
     traits: [
       "Braced",
       "WithStatements",

CodeGeneration/Sources/SyntaxSupport/DeclNodes.swift

@@ -82,7 +82,10 @@ public let DECL_NODES: [Node] = [
     base: .decl,
     nameForDiagnostics: "accessor",
     parserFunction: "parseAccessorDecl",
-    traits: ["WithAttributes"],
+    traits: [
+      "WithOptionalCodeBlock",
+      "WithAttributes",
+    ],
     children: [
       Child(
         name: "attributes",
@@ -493,6 +496,7 @@ public let DECL_NODES: [Node] = [
     traits: [
       "WithAttributes",
       "WithModifiers",
+      "WithOptionalCodeBlock",
     ],
     children: [
       Child(
@@ -879,6 +883,7 @@ public let DECL_NODES: [Node] = [
       "WithAttributes",
       "WithGenericParameters",
       "WithModifiers",
+      "WithOptionalCodeBlock",
     ],
     children: [
       Child(
@@ -1217,6 +1222,7 @@ public let DECL_NODES: [Node] = [
       "WithAttributes",
       "WithGenericParameters",
       "WithModifiers",
+      "WithOptionalCodeBlock",
     ],
     children: [
       Child(

CodeGeneration/Sources/SyntaxSupport/Traits.swift

@@ -151,6 +151,12 @@ public let TRAITS: [Trait] = [
       Child(name: "modifiers", kind: .node(kind: .declModifierList))
     ]
   ),
+  Trait(
+    traitName: "WithOptionalCodeBlock",
+    children: [
+      Child(name: "body", kind: .node(kind: .codeBlock), isOptional: true)
+    ]
+  ),
   Trait(
     traitName: "WithStatements",
     children: [

Examples/Sources/MacroExamples/Implementation/Peer/AddCompletionHandlerMacro.swift

@@ -34,9 +34,9 @@ public struct AddCompletionHandlerMacro: PeerMacro {
       var newEffects: FunctionEffectSpecifiersSyntax
       if let existingEffects = funcDecl.signature.effectSpecifiers {
         newEffects = existingEffects
-        newEffects.asyncSpecifier = .keyword(.async)
+        newEffects.asyncSpecifier = .keyword(.async, trailingTrivia: .space)
       } else {
-        newEffects = FunctionEffectSpecifiersSyntax(asyncSpecifier: .keyword(.async))
+        newEffects = FunctionEffectSpecifiersSyntax(asyncSpecifier: .keyword(.async, trailingTrivia: .space))
       }
 
       var newSignature = funcDecl.signature

Examples/Tests/MacroExamples/Implementation/Expression/AddBlockerTests.swift

@@ -39,6 +39,33 @@ final class AddBlockerTests: XCTestCase {
     )
   }
 
+  func testExpansionWithSubtractionAppliesFixIt() {
+    assertMacroExpansion(
+      """
+      #addBlocker(x * y + z)
+      """,
+      expandedSource: """
+        x * y - z
+        """,
+      diagnostics: [
+        DiagnosticSpec(
+          message: "blocked an add; did you mean to subtract?",
+          line: 1,
+          column: 19,
+          severity: .warning,
+          fixIts: [FixItSpec(message: "use '-'")]
+        )
+      ],
+      macros: macros,
+      applyFixIts: ["use '-'"],
+      fixedSource:
+        """
+        #addBlocker(x * y - z)
+        """,
+      indentationWidth: .spaces(2)
+    )
+  }
+
   func testExpansionPreservesSubtraction() {
     assertMacroExpansion(
       """

Examples/Tests/MacroExamples/Implementation/Peer/AddCompletionHandlerMacroTests.swift

@@ -98,4 +98,44 @@ final class AddCompletionHandlerMacroTests: XCTestCase {
       indentationWidth: .spaces(2)
     )
   }
+
+  func testExpansionOnNonAsyncFunctionAppliesFixIt() {
+    assertMacroExpansion(
+      """
+      struct Test {
+        @AddCompletionHandler
+        func fetchData() -> String {
+          return "Hello, World!"
+        }
+      }
+      """,
+      expandedSource: """
+        struct Test {
+          func fetchData() -> String {
+            return "Hello, World!"
+          }
+        }
+        """,
+      diagnostics: [
+        DiagnosticSpec(
+          message: "can only add a completion-handler variant to an 'async' function",
+          line: 3,
+          column: 3,
+          severity: .error,
+          fixIts: [FixItSpec(message: "add 'async'")]
+        )
+      ],
+      macros: macros,
+      applyFixIts: ["add 'async'"],
+      fixedSource: """
+        struct Test {
+          @AddCompletionHandler
+          func fetchData() async -> String {
+            return "Hello, World!"
+          }
+        }
+        """,
+      indentationWidth: .spaces(2)
+    )
+  }
 }

Release Notes/511.md

@@ -20,6 +20,10 @@
   - Description: Enum to exhaustively switch over all different syntax nodes of each base type.
   - Pull Request: https://github.com/apple/swift-syntax/pull/2351
 
+- `WithOptionalCodeBlock`
+  - Description: A trait for syntax nodes that have an optional code block, such as `FunctionDeclSyntax` and `InitializerDeclSyntax`.
+  - Pull Request: https://github.com/apple/swift-syntax/pull/2359
+
 ## API Behavior Changes
 
 ## Deprecations

Sources/SwiftParser/generated/LayoutNodes+Parsable.swift

@@ -126,6 +126,24 @@ extension CodeBlockItemSyntax: SyntaxParseable {
   }
 }
 
+extension CodeBlockSyntax: SyntaxParseable {
+  public static func parse(from parser: inout Parser) -> Self {
+    // Keep the parser alive so that the arena in which `raw` is allocated
+    // doesn’t get deallocated before we have a chance to create a syntax node
+    // from it. We can’t use `parser.arena` as the parameter to
+    // `Syntax(raw:arena:)` because the node might have been re-used during an
+    // incremental parse and would then live in a different arena than
+    // `parser.arena`.
+    defer {
+      withExtendedLifetime(parser) {
+      }
+    }
+    let node = parser.parseCodeBlock()
+    let raw = RawSyntax(parser.parseRemainder(into: node))
+    return Syntax(raw: raw, rawNodeArena: raw.arena).cast(Self.self)
+  }
+}
+
 extension DeclSyntax: SyntaxParseable {
   public static func parse(from parser: inout Parser) -> Self {
     // Keep the parser alive so that the arena in which `raw` is allocated

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

@@ -401,6 +401,7 @@ These articles are intended for developers wishing to contribute to SwiftSyntax
 - <doc:SwiftSyntax/WithCodeBlockSyntax>
 - <doc:SwiftSyntax/WithGenericParametersSyntax>
 - <doc:SwiftSyntax/WithModifiersSyntax>
+- <doc:SwiftSyntax/WithOptionalCodeBlockSyntax>
 - <doc:SwiftSyntax/WithStatementsSyntax>
 - <doc:SwiftSyntax/WithTrailingCommaSyntax>
 

Sources/SwiftSyntax/generated/SyntaxTraits.swift

@@ -570,6 +570,43 @@ public extension SyntaxProtocol {
   }
 }
 
+// MARK: - WithOptionalCodeBlockSyntax
+
+
+public protocol WithOptionalCodeBlockSyntax: SyntaxProtocol {
+  var body: CodeBlockSyntax? {
+    get
+    set
+  }
+}
+
+public extension WithOptionalCodeBlockSyntax {
+  /// Without this function, the `with` function defined on `SyntaxProtocol`
+  /// does not work on existentials of this protocol type.
+  @_disfavoredOverload
+  func with<T>(_ keyPath: WritableKeyPath<WithOptionalCodeBlockSyntax, T>, _ newChild: T) -> WithOptionalCodeBlockSyntax {
+    var copy: WithOptionalCodeBlockSyntax = self
+    copy[keyPath: keyPath] = newChild
+    return copy
+  }
+}
+
+public extension SyntaxProtocol {
+  /// Check whether the non-type erased version of this syntax node conforms to
+  /// `WithOptionalCodeBlockSyntax`.
+  /// Note that this will incur an existential conversion.
+  func isProtocol(_: WithOptionalCodeBlockSyntax.Protocol) -> Bool {
+    return self.asProtocol(WithOptionalCodeBlockSyntax.self) != nil
+  }
+  
+  /// Return the non-type erased version of this syntax node if it conforms to
+  /// `WithOptionalCodeBlockSyntax`. Otherwise return `nil`.
+  /// Note that this will incur an existential conversion.
+  func asProtocol(_: WithOptionalCodeBlockSyntax.Protocol) -> WithOptionalCodeBlockSyntax? {
+    return Syntax(self).asProtocol(SyntaxProtocol.self) as? WithOptionalCodeBlockSyntax
+  }
+}
+
 // MARK: - WithStatementsSyntax
 
 
@@ -649,7 +686,7 @@ public extension SyntaxProtocol {
 
 extension AccessorBlockSyntax: BracedSyntax {}
 
-extension AccessorDeclSyntax: WithAttributesSyntax {}
+extension AccessorDeclSyntax: WithOptionalCodeBlockSyntax, WithAttributesSyntax {}
 
 extension AccessorEffectSpecifiersSyntax: EffectSpecifiersSyntax {}
 
@@ -693,7 +730,7 @@ extension DeclNameArgumentsSyntax: ParenthesizedSyntax {}
 
 extension DeferStmtSyntax: WithCodeBlockSyntax {}
 
-extension DeinitializerDeclSyntax: WithAttributesSyntax, WithModifiersSyntax {}
+extension DeinitializerDeclSyntax: WithAttributesSyntax, WithModifiersSyntax, WithOptionalCodeBlockSyntax {}
 
 extension DictionaryElementSyntax: WithTrailingCommaSyntax {}
 
@@ -723,7 +760,7 @@ extension ExtensionDeclSyntax: DeclGroupSyntax, WithAttributesSyntax, WithModifi
 
 extension ForStmtSyntax: WithCodeBlockSyntax {}
 
-extension FunctionDeclSyntax: NamedDeclSyntax, WithAttributesSyntax, WithGenericParametersSyntax, WithModifiersSyntax {}
+extension FunctionDeclSyntax: NamedDeclSyntax, WithAttributesSyntax, WithGenericParametersSyntax, WithModifiersSyntax, WithOptionalCodeBlockSyntax {}
 
 extension FunctionEffectSpecifiersSyntax: EffectSpecifiersSyntax {}
 
@@ -747,7 +784,7 @@ extension ImportDeclSyntax: WithAttributesSyntax, WithModifiersSyntax {}
 
 extension InheritedTypeSyntax: WithTrailingCommaSyntax {}
 
-extension InitializerDeclSyntax: WithAttributesSyntax, WithGenericParametersSyntax, WithModifiersSyntax {}
+extension InitializerDeclSyntax: WithAttributesSyntax, WithGenericParametersSyntax, WithModifiersSyntax, WithOptionalCodeBlockSyntax {}
 
 extension LabeledExprSyntax: WithTrailingCommaSyntax {}
 

Sources/SwiftSyntaxBuilder/SyntaxNodeWithBody.swift

@@ -40,11 +40,9 @@ extension SyntaxStringInterpolation {
   }
 }
 
-// MARK: - HasCodeBlock
-
-public protocol HasTrailingCodeBlock {
-  var body: CodeBlockSyntax { get set }
+// MARK: - HasTrailingCodeBlock
 
+public protocol HasTrailingCodeBlock: WithCodeBlockSyntax {
   /// Constructs a syntax node where `header` builds the text of the node before the body in braces and `bodyBuilder` is used to build the node’s body.
   ///
   /// For example, you can construct
@@ -90,11 +88,9 @@ extension ForStmtSyntax: HasTrailingCodeBlock {}
 extension GuardStmtSyntax: HasTrailingCodeBlock {}
 extension WhileStmtSyntax: HasTrailingCodeBlock {}
 
-// MARK: - HasOptionalCodeBlock
-
-public protocol HasTrailingOptionalCodeBlock {
-  var body: CodeBlockSyntax? { get set }
+// MARK: - WithOptionalCodeBlockSyntax
 
+public extension WithOptionalCodeBlockSyntax where Self: DeclSyntaxProtocol {
   /// Constructs a syntax node where `header` builds the text of the node before the body in braces and `bodyBuilder` is used to build the node’s body.
   ///
   /// For example, you can construct
@@ -114,10 +110,6 @@ public protocol HasTrailingOptionalCodeBlock {
   /// ```
   ///
   /// Throws an error if `header` defines a different node type than the type the initializer is called on. E.g. if calling `try FunctionDeclSyntax("init") {}`
-  init(_ header: SyntaxNodeString, @CodeBlockItemListBuilder bodyBuilder: () throws -> CodeBlockItemListSyntax) throws
-}
-
-public extension HasTrailingOptionalCodeBlock where Self: DeclSyntaxProtocol {
   init(_ header: SyntaxNodeString, @CodeBlockItemListBuilder bodyBuilder: () throws -> CodeBlockItemListSyntax) throws {
     let decl = DeclSyntax("\(header) {}")
     guard let castedDecl = decl.as(Self.self) else {
@@ -128,11 +120,6 @@ public extension HasTrailingOptionalCodeBlock where Self: DeclSyntaxProtocol {
   }
 }
 
-extension AccessorDeclSyntax: HasTrailingOptionalCodeBlock {}
-extension DeinitializerDeclSyntax: HasTrailingOptionalCodeBlock {}
-extension FunctionDeclSyntax: HasTrailingOptionalCodeBlock {}
-extension InitializerDeclSyntax: HasTrailingOptionalCodeBlock {}
-
 // MARK: HasTrailingMemberDeclBlock
 
 public protocol HasTrailingMemberDeclBlock {

Sources/SwiftSyntaxBuilder/generated/SyntaxExpressibleByStringInterpolationConformances.swift

@@ -26,6 +26,8 @@ extension ClosureParameterSyntax: SyntaxExpressibleByStringInterpolation {}
 
 extension CodeBlockItemSyntax: SyntaxExpressibleByStringInterpolation {}
 
+extension CodeBlockSyntax: SyntaxExpressibleByStringInterpolation {}
+
 extension DeclSyntax: SyntaxExpressibleByStringInterpolation {}
 
 extension EnumCaseParameterSyntax: SyntaxExpressibleByStringInterpolation {}