Skip to content

Replace expression in ClosureCaptureSyntax with initializer clause #2763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 7, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions CodeGeneration/Sources/SyntaxSupport/ExprNodes.swift
Original file line number Diff line number Diff line change
Expand Up @@ -341,19 +341,13 @@ public let EXPR_NODES: [Node] = [
),
Child(
name: "name",
kind: .token(choices: [.token(.identifier)]),
isOptional: true
kind: .token(choices: [.token(.identifier)])
),
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)]),
Expand Down
7 changes: 1 addition & 6 deletions Sources/SwiftLexicalLookup/IdentifiableSyntax.swift
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,6 @@ extension ClosureShorthandParameterSyntax: IdentifiableSyntax {

extension ClosureCaptureSyntax: IdentifiableSyntax {
@_spi(Experimental) public var identifier: TokenSyntax {
/* Doesn't work with closures like:
_ = { [y=1+2] in
print(y)
}
*/
expression.as(DeclReferenceExprSyntax.self)!.baseName
name
}
}
37 changes: 17 additions & 20 deletions Sources/SwiftParser/Expressions.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1615,7 +1615,7 @@ extension Parser {
}

extension Parser {
mutating func parseDefaultArgument() -> RawInitializerClauseSyntax {
mutating func parseInitializerClause() -> RawInitializerClauseSyntax {
let unexpectedBeforeEq: RawUnexpectedNodesSyntax?
let eq: RawTokenSyntax
if let comparison = self.consumeIfContextualPunctuator("==") {
Expand Down Expand Up @@ -1704,29 +1704,28 @@ extension Parser {
let specifier = self.parseClosureCaptureSpecifiers()

// The thing being capture specified is an identifier, or as an identifier
// followed by an expression.
// followed by an initializer clause.
let unexpectedBeforeName: RawUnexpectedNodesSyntax?
let name: RawTokenSyntax?
let unexpectedBeforeEqual: RawUnexpectedNodesSyntax?
let equal: RawTokenSyntax?
let expression: RawExprSyntax
let name: RawTokenSyntax
let initializer: RawInitializerClauseSyntax?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should be able to hoist the parsing of name out of the if statement and then use self.at(.equal) instead of self.peek(isAt: .equal)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion. I moved name parsing to before the if statement.

As an interesting artifact, self token will not be remapped to identifier when parsing capture of [self = 123] form. Out of curiosity, was there a particular reason for this remapping? As far as I checked, e.g. in let self = 123 self is classified as a keyword.

if self.peek(isAt: .equal) {
// The name is a new declaration.
// The name is a new declaration with
// initializer clause.
(unexpectedBeforeName, name) = self.expect(
.identifier,
TokenSpec(.self, remapping: .identifier),
default: .identifier
)
(unexpectedBeforeEqual, equal) = self.expect(.equal)
expression = self.parseExpression(flavor: .basic, pattern: .none)
initializer = self.parseInitializerClause()
} else {
// This is the simple case - the identifier is both the name and
// the expression to capture.
unexpectedBeforeName = nil
name = nil
unexpectedBeforeEqual = nil
equal = nil
expression = RawExprSyntax(self.parseIdentifierExpression(flavor: .basic))
// This is the simple case - the identifier is the name and
// the initializer clause is empty.
(unexpectedBeforeName, name) = self.expect(
.identifier,
TokenSpec(.self),
default: .identifier
)
initializer = nil
}

keepGoing = self.consume(if: .comma)
Expand All @@ -1735,11 +1734,9 @@ extension Parser {
specifier: specifier,
unexpectedBeforeName,
name: name,
unexpectedBeforeEqual,
equal: equal,
expression: expression,
initializer: initializer,
trailingComma: keepGoing,
arena: self.arena
arena: arena
)
)
} while keepGoing != nil && self.hasProgressed(&loopProgress)
Expand Down
4 changes: 2 additions & 2 deletions Sources/SwiftParser/Parameters.swift
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ extension Parser {

let defaultValue: RawInitializerClauseSyntax?
if self.at(.equal) || self.atContextualPunctuator("==") {
defaultValue = self.parseDefaultArgument()
defaultValue = self.parseInitializerClause()
} else {
defaultValue = nil
}
Expand Down Expand Up @@ -234,7 +234,7 @@ extension Parser {

let defaultValue: RawInitializerClauseSyntax?
if self.at(.equal) || self.atContextualPunctuator("==") {
defaultValue = self.parseDefaultArgument()
defaultValue = self.parseInitializerClause()
} else {
defaultValue = nil
}
Expand Down
27 changes: 0 additions & 27 deletions Sources/SwiftSyntax/Convenience.swift
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,6 @@
//
//===----------------------------------------------------------------------===//

extension ClosureCaptureSyntax {

/// Creates a ``ClosureCaptureSyntax`` with a `name`, and automatically adds an `equal` token to it since the name is non-optional.
///
/// - SeeAlso: ``ClosureCaptureSyntax/init(leadingTrivia:_:specifier:_:name:_:equal:_:expression:_:trailingComma:_:trailingTrivia:)``.
///
public init(
leadingTrivia: Trivia? = nil,
specifier: ClosureCaptureSpecifierSyntax? = nil,
name: TokenSyntax,
equal: TokenSyntax = TokenSyntax.equalToken(),
expression: some ExprSyntaxProtocol,
trailingComma: TokenSyntax? = nil,
trailingTrivia: Trivia? = nil
) {
self.init(
leadingTrivia: leadingTrivia,
specifier: specifier,
name: name as TokenSyntax?,
equal: equal,
expression: expression,
trailingComma: trailingComma,
trailingTrivia: trailingTrivia
)
}
}

extension EnumCaseParameterSyntax {

/// Creates an ``EnumCaseParameterSyntax`` with a `firstName`, and automatically adds a `colon` to it.
Expand Down
16 changes: 6 additions & 10 deletions Sources/SwiftSyntax/generated/ChildNameForKeyPath.swift
Original file line number Diff line number Diff line change
Expand Up @@ -499,16 +499,12 @@ public func childName(_ keyPath: AnyKeyPath) -> String? {
return "unexpectedBetweenSpecifierAndName"
case \ClosureCaptureSyntax.name:
return "name"
case \ClosureCaptureSyntax.unexpectedBetweenNameAndEqual:
return "unexpectedBetweenNameAndEqual"
case \ClosureCaptureSyntax.equal:
return "equal"
case \ClosureCaptureSyntax.unexpectedBetweenEqualAndExpression:
return "unexpectedBetweenEqualAndExpression"
case \ClosureCaptureSyntax.expression:
return "expression"
case \ClosureCaptureSyntax.unexpectedBetweenExpressionAndTrailingComma:
return "unexpectedBetweenExpressionAndTrailingComma"
case \ClosureCaptureSyntax.unexpectedBetweenNameAndInitializer:
return "unexpectedBetweenNameAndInitializer"
case \ClosureCaptureSyntax.initializer:
return "initializer"
case \ClosureCaptureSyntax.unexpectedBetweenInitializerAndTrailingComma:
return "unexpectedBetweenInitializerAndTrailingComma"
case \ClosureCaptureSyntax.trailingComma:
return "trailingComma"
case \ClosureCaptureSyntax.unexpectedAfterTrailingComma:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1167,73 +1167,6 @@ extension ClassDeclSyntax {
}
}

extension ClosureCaptureSyntax {
@available(*, deprecated, renamed: "unexpectedBetweenNameAndEqual")
public var unexpectedBetweenNameAndAssignToken: UnexpectedNodesSyntax? {
get {
return unexpectedBetweenNameAndEqual
}
set {
unexpectedBetweenNameAndEqual = newValue
}
}

@available(*, deprecated, renamed: "equal")
public var assignToken: TokenSyntax? {
get {
return equal
}
set {
equal = newValue
}
}

@available(*, deprecated, renamed: "unexpectedBetweenEqualAndExpression")
public var unexpectedBetweenAssignTokenAndExpression: UnexpectedNodesSyntax? {
get {
return unexpectedBetweenEqualAndExpression
}
set {
unexpectedBetweenEqualAndExpression = newValue
}
}

@available(*, deprecated, renamed: "ClosureCaptureSyntax(leadingTrivia:_:specifier:_:name:_:equal:_:expression:_:trailingComma:_:trailingTrivia:)")
@_disfavoredOverload
public init(
leadingTrivia: Trivia? = nil,
_ unexpectedBeforeSpecifier: UnexpectedNodesSyntax? = nil,
specifier: ClosureCaptureSpecifierSyntax? = nil,
_ unexpectedBetweenSpecifierAndName: UnexpectedNodesSyntax? = nil,
name: TokenSyntax? = nil,
_ unexpectedBetweenNameAndAssignToken: UnexpectedNodesSyntax? = nil,
assignToken: TokenSyntax? = nil,
_ unexpectedBetweenAssignTokenAndExpression: UnexpectedNodesSyntax? = nil,
expression: some ExprSyntaxProtocol,
_ unexpectedBetweenExpressionAndTrailingComma: UnexpectedNodesSyntax? = nil,
trailingComma: TokenSyntax? = nil,
_ unexpectedAfterTrailingComma: UnexpectedNodesSyntax? = nil,
trailingTrivia: Trivia? = nil

) {
self.init(
leadingTrivia: leadingTrivia,
unexpectedBeforeSpecifier,
specifier: specifier,
unexpectedBetweenSpecifierAndName,
name: name,
unexpectedBetweenNameAndAssignToken,
equal: assignToken,
unexpectedBetweenAssignTokenAndExpression,
expression: expression,
unexpectedBetweenExpressionAndTrailingComma,
trailingComma: trailingComma,
unexpectedAfterTrailingComma,
trailingTrivia: trailingTrivia
)
}
}

Comment on lines -1170 to -1236
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

People might still be relying on these compatibility overloads, so we shouldn’t remove them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added those to SwiftSyntaxCompatibility.swift.

extension ClosureParameterClauseSyntax {
@available(*, deprecated, renamed: "unexpectedBetweenLeftParenAndParameters")
public var unexpectedBetweenLeftParenAndParameterList: UnexpectedNodesSyntax? {
Expand Down
50 changes: 19 additions & 31 deletions Sources/SwiftSyntax/generated/raw/RawSyntaxNodesC.swift
Original file line number Diff line number Diff line change
Expand Up @@ -935,30 +935,26 @@ public struct RawClosureCaptureSyntax: RawSyntaxNodeProtocol {
_ unexpectedBeforeSpecifier: RawUnexpectedNodesSyntax? = nil,
specifier: RawClosureCaptureSpecifierSyntax?,
_ unexpectedBetweenSpecifierAndName: RawUnexpectedNodesSyntax? = nil,
name: RawTokenSyntax?,
_ unexpectedBetweenNameAndEqual: RawUnexpectedNodesSyntax? = nil,
equal: RawTokenSyntax?,
_ unexpectedBetweenEqualAndExpression: RawUnexpectedNodesSyntax? = nil,
expression: RawExprSyntax,
_ unexpectedBetweenExpressionAndTrailingComma: RawUnexpectedNodesSyntax? = nil,
name: RawTokenSyntax,
_ unexpectedBetweenNameAndInitializer: RawUnexpectedNodesSyntax? = nil,
initializer: RawInitializerClauseSyntax?,
_ unexpectedBetweenInitializerAndTrailingComma: RawUnexpectedNodesSyntax? = nil,
trailingComma: RawTokenSyntax?,
_ unexpectedAfterTrailingComma: RawUnexpectedNodesSyntax? = nil,
arena: __shared SyntaxArena
) {
let raw = RawSyntax.makeLayout(
kind: .closureCapture, uninitializedCount: 11, arena: arena) { layout in
kind: .closureCapture, uninitializedCount: 9, arena: arena) { layout in
layout.initialize(repeating: nil)
layout[0] = unexpectedBeforeSpecifier?.raw
layout[1] = specifier?.raw
layout[2] = unexpectedBetweenSpecifierAndName?.raw
layout[3] = name?.raw
layout[4] = unexpectedBetweenNameAndEqual?.raw
layout[5] = equal?.raw
layout[6] = unexpectedBetweenEqualAndExpression?.raw
layout[7] = expression.raw
layout[8] = unexpectedBetweenExpressionAndTrailingComma?.raw
layout[9] = trailingComma?.raw
layout[10] = unexpectedAfterTrailingComma?.raw
layout[3] = name.raw
layout[4] = unexpectedBetweenNameAndInitializer?.raw
layout[5] = initializer?.raw
layout[6] = unexpectedBetweenInitializerAndTrailingComma?.raw
layout[7] = trailingComma?.raw
layout[8] = unexpectedAfterTrailingComma?.raw
}
self.init(unchecked: raw)
}
Expand All @@ -975,36 +971,28 @@ public struct RawClosureCaptureSyntax: RawSyntaxNodeProtocol {
layoutView.children[2].map(RawUnexpectedNodesSyntax.init(raw:))
}

public var name: RawTokenSyntax? {
layoutView.children[3].map(RawTokenSyntax.init(raw:))
public var name: RawTokenSyntax {
layoutView.children[3].map(RawTokenSyntax.init(raw:))!
}

public var unexpectedBetweenNameAndEqual: RawUnexpectedNodesSyntax? {
public var unexpectedBetweenNameAndInitializer: RawUnexpectedNodesSyntax? {
layoutView.children[4].map(RawUnexpectedNodesSyntax.init(raw:))
}

public var equal: RawTokenSyntax? {
layoutView.children[5].map(RawTokenSyntax.init(raw:))
public var initializer: RawInitializerClauseSyntax? {
layoutView.children[5].map(RawInitializerClauseSyntax.init(raw:))
}

public var unexpectedBetweenEqualAndExpression: RawUnexpectedNodesSyntax? {
public var unexpectedBetweenInitializerAndTrailingComma: RawUnexpectedNodesSyntax? {
layoutView.children[6].map(RawUnexpectedNodesSyntax.init(raw:))
}

public var expression: RawExprSyntax {
layoutView.children[7].map(RawExprSyntax.init(raw:))!
}

public var unexpectedBetweenExpressionAndTrailingComma: RawUnexpectedNodesSyntax? {
layoutView.children[8].map(RawUnexpectedNodesSyntax.init(raw:))
}

public var trailingComma: RawTokenSyntax? {
layoutView.children[9].map(RawTokenSyntax.init(raw:))
layoutView.children[7].map(RawTokenSyntax.init(raw:))
}

public var unexpectedAfterTrailingComma: RawUnexpectedNodesSyntax? {
layoutView.children[10].map(RawUnexpectedNodesSyntax.init(raw:))
layoutView.children[8].map(RawUnexpectedNodesSyntax.init(raw:))
}
}

Expand Down
10 changes: 4 additions & 6 deletions Sources/SwiftSyntax/generated/raw/RawSyntaxValidation.swift
Original file line number Diff line number Diff line change
Expand Up @@ -563,18 +563,16 @@ func validateLayout(layout: RawSyntaxBuffer, as kind: SyntaxKind) {
assertNoError(kind, 7, verify(layout[7], as: RawTokenSyntax?.self, tokenChoices: [.tokenKind(.rightParen)]))
assertNoError(kind, 8, verify(layout[8], as: RawUnexpectedNodesSyntax?.self))
case .closureCapture:
assert(layout.count == 11)
assert(layout.count == 9)
assertNoError(kind, 0, verify(layout[0], as: RawUnexpectedNodesSyntax?.self))
assertNoError(kind, 1, verify(layout[1], as: RawClosureCaptureSpecifierSyntax?.self))
assertNoError(kind, 2, verify(layout[2], as: RawUnexpectedNodesSyntax?.self))
assertNoError(kind, 3, verify(layout[3], as: RawTokenSyntax?.self, tokenChoices: [.tokenKind(.identifier)]))
assertNoError(kind, 3, verify(layout[3], as: RawTokenSyntax.self, tokenChoices: [.tokenKind(.identifier)]))
assertNoError(kind, 4, verify(layout[4], as: RawUnexpectedNodesSyntax?.self))
assertNoError(kind, 5, verify(layout[5], as: RawTokenSyntax?.self, tokenChoices: [.tokenKind(.equal)]))
assertNoError(kind, 5, verify(layout[5], as: RawInitializerClauseSyntax?.self))
assertNoError(kind, 6, verify(layout[6], as: RawUnexpectedNodesSyntax?.self))
assertNoError(kind, 7, verify(layout[7], as: RawExprSyntax.self))
assertNoError(kind, 7, verify(layout[7], as: RawTokenSyntax?.self, tokenChoices: [.tokenKind(.comma)]))
assertNoError(kind, 8, verify(layout[8], as: RawUnexpectedNodesSyntax?.self))
assertNoError(kind, 9, verify(layout[9], as: RawTokenSyntax?.self, tokenChoices: [.tokenKind(.comma)]))
assertNoError(kind, 10, verify(layout[10], as: RawUnexpectedNodesSyntax?.self))
case .closureExpr:
assert(layout.count == 9)
assertNoError(kind, 0, verify(layout[0], as: RawUnexpectedNodesSyntax?.self))
Expand Down
Loading