Merge remote-tracking branch 'upstream/main' into generic-parameter-list-function-scope

Author: MAJKFL

CodeGeneration/Sources/SyntaxSupport/ExprNodes.swift

@@ -341,19 +341,13 @@ public let EXPR_NODES: [Node] = [
       ),
       Child(
         name: "name",
-        kind: .token(choices: [.token(.identifier)]),
-        isOptional: true
+        kind: .token(choices: [.token(.identifier), .keyword(.self)])
       ),
       Child(
-        name: "equal",
-        deprecatedName: "assignToken",
-        kind: .token(choices: [.token(.equal)]),
+        name: "initializer",
+        kind: .node(kind: .initializerClause),
         isOptional: true
       ),
-      Child(
-        name: "expression",
-        kind: .node(kind: .expr)
-      ),
       Child(
         name: "trailingComma",
         kind: .token(choices: [.token(.comma)]),

CodeGeneration/Tests/ValidateSyntaxNodes/ValidateSyntaxNodes.swift

@@ -482,22 +482,22 @@ class ValidateSyntaxNodes: XCTestCase {
         ValidationFailure(
           node: .enumCaseElement,
           message:
-            "child 'rawValue' is named inconsistently with 'MatchingPatternConditionSyntax.initializer', which has the same type ('InitializerClauseSyntax')"
+            "child 'rawValue' is named inconsistently with 'ClosureCaptureSyntax.initializer', which has the same type ('InitializerClauseSyntax')"
         ),
         ValidationFailure(
           node: .enumCaseParameter,
           message:
-            "child 'defaultValue' is named inconsistently with 'MatchingPatternConditionSyntax.initializer', which has the same type ('InitializerClauseSyntax')"
+            "child 'defaultValue' is named inconsistently with 'ClosureCaptureSyntax.initializer', which has the same type ('InitializerClauseSyntax')"
         ),
         ValidationFailure(
           node: .functionParameter,
           message:
-            "child 'defaultValue' is named inconsistently with 'MatchingPatternConditionSyntax.initializer', which has the same type ('InitializerClauseSyntax')"
+            "child 'defaultValue' is named inconsistently with 'ClosureCaptureSyntax.initializer', which has the same type ('InitializerClauseSyntax')"
         ),
         ValidationFailure(
           node: .macroDecl,
           message:
-            "child 'definition' is named inconsistently with 'MatchingPatternConditionSyntax.initializer', which has the same type ('InitializerClauseSyntax')"
+            "child 'definition' is named inconsistently with 'ClosureCaptureSyntax.initializer', which has the same type ('InitializerClauseSyntax')"
         ),
         // MARK: Miscellaneous
         ValidationFailure(

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.7
+// swift-tools-version:5.8
 
 import Foundation
 import PackageDescription
@@ -143,7 +143,7 @@ let package = Package(
 
     .target(
       name: "SwiftIfConfig",
-      dependencies: ["SwiftSyntax", "SwiftDiagnostics", "SwiftOperators"],
+      dependencies: ["SwiftSyntax", "SwiftSyntaxBuilder", "SwiftDiagnostics", "SwiftOperators"],
       exclude: ["CMakeLists.txt"]
     ),
 

Release Notes/600.md

@@ -32,7 +32,7 @@
   - Description: The `throwsSpecifier` for the effects nodes (`AccessorEffectSpecifiers`, `FunctionEffectSpecifiers`, `TypeEffectSpecifiers`, `EffectSpecifiers`) has been replaced with `throwsClause`, which captures both the throws specifier and the (optional) thrown error type, as introduced by SE-0413.
   - Pull Request: https://github.com/swiftlang/swift-syntax/pull/2379
 
-- `String.isValidIdentifier(for:)`
+- `String.isValidSwiftIdentifier(for:)`
   - Description: `SwiftParser` adds an extension on `String` to check if it can be used as an identifier in a given context.
   - Pull Request: https://github.com/swiftlang/swift-syntax/pull/2434
 

Release Notes/601.md

@@ -31,6 +31,10 @@
   - Description: `IncrementalEdit` is being dropped for `SourceEdit`. `SourceEdit` has deprecated compatibility layers to make it API-compatible with `IncrementalEdit`
   - Issue: https://github.com/apple/swift-syntax/issues/2532
   - Pull request: https://github.com/apple/swift-syntax/pull/2604
+  
+- `ClosureCaptureSyntax.init(leadingTrivia:specifier:name:equal:expression:trailingComma:trailingTrivia:)` deprecated in favor of a new `ClosureCaptureSyntax.init(leadingTrivia:_:specifier:_:name:_:initializer:_:trailingComma:_:trailingTrivia:)` initializer.
+  - Description: `ClosureCaptureSyntax` now has an `initializer` property instead of `equal` and `expression`. Additionally, the `name` property is no longer optional.
+  - Pull request: https://github.com/swiftlang/swift-syntax/pull/2763 
 
 ## API-Incompatible Changes
 
@@ -39,6 +43,16 @@
   - Issue: https://github.com/apple/swift-syntax/issues/405
   - Pull Request: https://github.com/apple/swift-syntax/pull/2605
 
+- `FixIt.Change` gained a new case `replaceChild(data:)`.
+  - Description: The new case covers the replacement of a child node with another node.
+  - Issue: https://github.com/swiftlang/swift-syntax/issues/2205
+  - Pull Request: https://github.com/swiftlang/swift-syntax/pull/2758
+  - Migration steps: In exhaustive switches over `FixIt.Change`, cover the new case.
+
+- `ClosureCaptureSyntax.name` is no longer optional.
+  - Description: Due to the new `ClosureCaptureSyntax` node structure, `name` property is non-optional.
+  - Pull request: https://github.com/swiftlang/swift-syntax/pull/2763 
+
 ## Template
 
 - *Affected API or two word description*

Sources/SwiftCompilerPluginMessageHandling/Diagnostics.swift

@@ -130,12 +130,15 @@ extension PluginMessage.Diagnostic {
               to: .afterTrailingTrivia
             )
             text = newTrivia.description
+          case .replaceChild(let replaceChildData):
+            range = sourceManager.range(replaceChildData.replacementRange, in: replaceChildData.parent)
+            text = replaceChildData.newChild.description
           #if RESILIENT_LIBRARIES
           @unknown default:
             fatalError()
           #endif
           }
-          guard let range = range else {
+          guard let range else {
             return nil
           }
           return .init(

Sources/SwiftCompilerPluginMessageHandling/PluginMacroExpansionContext.swift

@@ -169,20 +169,25 @@ class SourceManager {
     of node: Syntax,
     from startKind: PositionInSyntaxNode = .afterLeadingTrivia,
     to endKind: PositionInSyntaxNode = .beforeTrailingTrivia
+  ) -> SourceRange? {
+    range(node.position(at: startKind)..<node.position(at: endKind), in: node)
+  }
+
+  /// Get ``SourceRange`` (file name + UTF-8 offset range) of `localRange` in `node`'s root node, which must be one
+  /// of the returned values from `add(_:)`.
+  func range(
+    _ localRange: @autoclosure () -> Range<AbsolutePosition>,
+    in node: some SyntaxProtocol
   ) -> SourceRange? {
     guard let base = self.knownSourceSyntax[node.root.id] else {
       return nil
     }
-    let localStartPosition = node.position(at: startKind)
-    let localEndPosition = node.position(at: endKind)
-    precondition(localStartPosition <= localEndPosition)
-
     let positionOffset = base.location.offset
-
+    let localRange = localRange()
     return SourceRange(
       fileName: base.location.fileName,
-      startUTF8Offset: localStartPosition.advanced(by: positionOffset).utf8Offset,
-      endUTF8Offset: localEndPosition.advanced(by: positionOffset).utf8Offset
+      startUTF8Offset: localRange.lowerBound.advanced(by: positionOffset).utf8Offset,
+      endUTF8Offset: localRange.upperBound.advanced(by: positionOffset).utf8Offset
     )
   }
 

Sources/SwiftDiagnostics/Convenience.swift

@@ -51,4 +51,20 @@ extension FixIt {
       ]
     )
   }
+
+  public static func replaceChild<Parent: SyntaxProtocol, Child: SyntaxProtocol>(
+    message: FixItMessage,
+    parent: Parent,
+    replacingChildAt keyPath: WritableKeyPath<Parent, Child?> & Sendable,
+    with newChild: Child
+  ) -> Self {
+    FixIt(
+      message: message,
+      changes: [
+        .replaceChild(
+          data: FixIt.Change.ReplacingOptionalChildData(parent: parent, newChild: newChild, keyPath: keyPath)
+        )
+      ]
+    )
+  }
 }

Sources/SwiftDiagnostics/FixIt.swift

@@ -27,15 +27,56 @@ public protocol FixItMessage: Sendable {
   var fixItID: MessageID { get }
 }
 
+/// Types conforming to this protocol provide the data required for replacing a child node of a parent node.
+///
+/// Conforming types should ensure the child of ``parent`` to be replaced at ``replacementRange`` is type-compatible
+/// with ``newChild``. Conforming types are stored as type-erased existentials (i.e. `any ReplacingChildData`) in
+///  ``FixIt/Change/replaceChild(data:)`` to keep ``FixIt`` type-erased.
+public protocol ReplacingChildData: Sendable {
+  associatedtype Parent: SyntaxProtocol
+  associatedtype Child: SyntaxProtocol
+
+  /// The node whose child node at ``replacementRange`` to be replaced by ``newChild``.
+  var parent: Parent { get }
+
+  /// The node to replace the child node of ``parent`` at ``replacementRange``.
+  var newChild: Child { get }
+
+  /// The absolute position range of the child node to be replaced.
+  ///
+  /// If a nil child node is to be replaced, conforming types should provide a zero-length range with both bounds
+  /// denoting the start position of ``newChild`` in ``parent`` after replacement.
+  var replacementRange: Range<AbsolutePosition> { get }
+}
+
 /// A Fix-It that can be applied to resolve a diagnostic.
 public struct FixIt: Sendable {
   public enum Change: Sendable {
+    struct ReplacingOptionalChildData<Parent: SyntaxProtocol, Child: SyntaxProtocol>: ReplacingChildData {
+      let parent: Parent
+      let newChild: Child
+      let keyPath: WritableKeyPath<Parent, Child?> & Sendable
+
+      var replacementRange: Range<AbsolutePosition> {
+        // need to upcast keyPath to strip Sendable for older Swift versions
+        let keyPath: WritableKeyPath<Parent, Child?> = keyPath
+        if let oldChild = parent[keyPath: keyPath] {
+          return oldChild.range
+        } else {
+          let newChild = parent.with(keyPath, newChild)[keyPath: keyPath]!
+          return newChild.position..<newChild.position
+        }
+      }
+    }
+
     /// Replace `oldNode` by `newNode`.
     case replace(oldNode: Syntax, newNode: Syntax)
     /// Replace the leading trivia on the given token
     case replaceLeadingTrivia(token: TokenSyntax, newTrivia: Trivia)
     /// Replace the trailing trivia on the given token
     case replaceTrailingTrivia(token: TokenSyntax, newTrivia: Trivia)
+    /// Replace the child node of the given parent node at the given replacement range with the given new child node
+    case replaceChild(data: any ReplacingChildData)
   }
 
   /// A description of what this Fix-It performs.
@@ -89,6 +130,12 @@ private extension FixIt.Change {
         range: token.endPositionBeforeTrailingTrivia..<token.endPosition,
         replacement: newTrivia.description
       )
+
+    case .replaceChild(let replacingChildData):
+      return SourceEdit(
+        range: replacingChildData.replacementRange,
+        replacement: replacingChildData.newChild.description
+      )
     }
   }
 }

Sources/SwiftIfConfig/BuildConfiguration.swift

@@ -44,7 +44,8 @@ public enum CanImportVersion {
 /// be imported is a complicated task only implemented in the Swift compiler.
 /// Therefore, queries are permitted to throw an error to report when they
 /// cannot answer a query, in which case this error will be reported to
-/// the caller.
+/// the caller and the condition will be treated as being "false", so the
+/// code covered by the condition will be inactive.
 public protocol BuildConfiguration {
   /// Determine whether a given custom build condition has been set.
   ///