Skip to content

[Variadic Generics] type parameter pack syntax change: T... -> each T #1384

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.

Sign up for GitHub

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 1 commit into from
Mar 3, 2023
Merged

[Variadic Generics] type parameter pack syntax change: T... -> each T #1384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions CodeGeneration/Sources/SyntaxSupport/gyb_generated/GenericNodes.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ public let GENERIC_NODES: [Node] = [
Child(name: "Attributes",
kind: .collection(kind: "AttributeList", collectionElementName: "Attribute"),
isOptional: true),
Child(name: "Each",
kind: .token(choices: [.keyword(text: "each")]),
nameForDiagnostics: "parameter pack specifier",
isOptional: true),
Child(name: "Name",
kind: .token(choices: [.token(tokenKind: "IdentifierToken")]),
nameForDiagnostics: "name"),
Child(name: "Ellipsis",
kind: .token(choices: [.token(tokenKind: "EllipsisToken")]),
nameForDiagnostics: "parameter pack specifier",
isOptional: true),
Child(name: "Colon",
kind: .token(choices: [.token(tokenKind: "ColonToken")]),
isOptional: true),
Expand Down
14 changes: 7 additions & 7 deletions Sources/SwiftParser/Declarations.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,14 +469,14 @@ extension Parser {
repeat {
let attributes = self.parseAttributeList()

let (unexpectedBeforeName, name) = self.expectIdentifier()
if attributes == nil && unexpectedBeforeName == nil && name.isMissing && elements.isEmpty {
// Parse the 'each' keyword for a type parameter pack 'each T'.
let each = self.consume(if: .keyword(.each))

let (unexpectedBetweenEachAndName, name) = self.expectIdentifier()
if attributes == nil && unexpectedBetweenEachAndName == nil && name.isMissing && elements.isEmpty {
Copy link
Member

Choose a reason for hiding this comment

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

You need to check that each is nil here as well, otherwise we could drop each and not round-trip. A test case that currently fails should be if you open a generic argument list, write each and then reach the end of the file, i.e.

func foo<each

Copy link
Contributor Author

Choose a reason for hiding this comment

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

each is supposed to be optional/nullable because the absence of each indicates a standard generic type parameter and the presence of each indicates a variadic type parameter pack. This was the case before my PR as well except prior to my syntax change, it was postfix ellipsis that made the distinction rather than the preceding each. Admittedly I do not know what is meant by "we could drop each and not round-trip"?

Copy link
Contributor

Choose a reason for hiding this comment

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

swift-syntax preserves each token in the source file in the parse tree as it was written, even if you hav something invalid like each not followed by a type parameter.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you @ahoppen , I have addressed this in my follow-up PR #1393

break
}

// Parse the ellipsis for a type parameter pack 'T...'.
let ellipsis = tryConsumeEllipsisPrefix()

// Parse the ':' followed by a type.
let colon = self.consume(if: .colon)
let unexpectedBeforeInherited: RawUnexpectedNodesSyntax?
Expand Down Expand Up @@ -506,9 +506,9 @@ extension Parser {
elements.append(
RawGenericParameterSyntax(
attributes: attributes,
unexpectedBeforeName,
each: each,
unexpectedBetweenEachAndName,
name: name,
ellipsis: ellipsis,
colon: colon,
unexpectedBeforeInherited,
inheritedType: inherited,
Expand Down
2 changes: 1 addition & 1 deletion Sources/SwiftRefactor/OpaqueParameterToGeneric.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ fileprivate class SomeParameterRewriter: SyntaxRewriter {

let genericParam = GenericParameterSyntax(
attributes: nil,
each: nil,
name: paramNameSyntax,
ellipsis: nil,
colon: colon,
inheritedType: inheritedType,
trailingComma: nil
Expand Down
32 changes: 16 additions & 16 deletions Sources/SwiftSyntax/generated/raw/RawSyntaxNodes.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9197,11 +9197,11 @@ public struct RawGenericParameterSyntax: RawSyntaxNodeProtocol {
public init(
_ unexpectedBeforeAttributes: RawUnexpectedNodesSyntax? = nil,
attributes: RawAttributeListSyntax?,
_ unexpectedBetweenAttributesAndName: RawUnexpectedNodesSyntax? = nil,
_ unexpectedBetweenAttributesAndEach: RawUnexpectedNodesSyntax? = nil,
each: RawTokenSyntax?,
_ unexpectedBetweenEachAndName: RawUnexpectedNodesSyntax? = nil,
name: RawTokenSyntax,
_ unexpectedBetweenNameAndEllipsis: RawUnexpectedNodesSyntax? = nil,
ellipsis: RawTokenSyntax?,
_ unexpectedBetweenEllipsisAndColon: RawUnexpectedNodesSyntax? = nil,
_ unexpectedBetweenNameAndColon: RawUnexpectedNodesSyntax? = nil,
colon: RawTokenSyntax?,
_ unexpectedBetweenColonAndInheritedType: RawUnexpectedNodesSyntax? = nil,
inheritedType: RawTypeSyntax?,
Expand All @@ -9215,11 +9215,11 @@ public struct RawGenericParameterSyntax: RawSyntaxNodeProtocol {
layout.initialize(repeating: nil)
layout[0] = unexpectedBeforeAttributes?.raw
layout[1] = attributes?.raw
layout[2] = unexpectedBetweenAttributesAndName?.raw
layout[3] = name.raw
layout[4] = unexpectedBetweenNameAndEllipsis?.raw
layout[5] = ellipsis?.raw
layout[6] = unexpectedBetweenEllipsisAndColon?.raw
layout[2] = unexpectedBetweenAttributesAndEach?.raw
layout[3] = each?.raw
layout[4] = unexpectedBetweenEachAndName?.raw
layout[5] = name.raw
layout[6] = unexpectedBetweenNameAndColon?.raw
layout[7] = colon?.raw
layout[8] = unexpectedBetweenColonAndInheritedType?.raw
layout[9] = inheritedType?.raw
Expand All @@ -9238,23 +9238,23 @@ public struct RawGenericParameterSyntax: RawSyntaxNodeProtocol {
layoutView.children[1].map(RawAttributeListSyntax.init(raw:))
}

public var unexpectedBetweenAttributesAndName: RawUnexpectedNodesSyntax? {
public var unexpectedBetweenAttributesAndEach: RawUnexpectedNodesSyntax? {
layoutView.children[2].map(RawUnexpectedNodesSyntax.init(raw:))
}

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

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

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

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

Expand Down
4 changes: 2 additions & 2 deletions Sources/SwiftSyntax/generated/raw/RawSyntaxValidation.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1232,9 +1232,9 @@ func validateLayout(layout: RawSyntaxBuffer, as kind: SyntaxKind) {
assertNoError(kind, 0, verify(layout[0], as: RawUnexpectedNodesSyntax?.self))
assertNoError(kind, 1, verify(layout[1], as: RawAttributeListSyntax?.self))
assertNoError(kind, 2, verify(layout[2], as: RawUnexpectedNodesSyntax?.self))
assertNoError(kind, 3, verify(layout[3], as: RawTokenSyntax.self))
assertNoError(kind, 3, verify(layout[3], as: RawTokenSyntax?.self))
assertNoError(kind, 4, verify(layout[4], as: RawUnexpectedNodesSyntax?.self))
assertNoError(kind, 5, verify(layout[5], as: RawTokenSyntax?.self))
assertNoError(kind, 5, verify(layout[5], as: RawTokenSyntax.self))
assertNoError(kind, 6, verify(layout[6], as: RawUnexpectedNodesSyntax?.self))
assertNoError(kind, 7, verify(layout[7], as: RawTokenSyntax?.self))
assertNoError(kind, 8, verify(layout[8], as: RawUnexpectedNodesSyntax?.self))
Expand Down
78 changes: 39 additions & 39 deletions Sources/SwiftSyntax/generated/syntaxNodes/SyntaxNodes.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10305,11 +10305,11 @@ public struct GenericParameterSyntax: SyntaxProtocol, SyntaxHashable {
leadingTrivia: Trivia? = nil,
_ unexpectedBeforeAttributes: UnexpectedNodesSyntax? = nil,
attributes: AttributeListSyntax? = nil,
_ unexpectedBetweenAttributesAndName: UnexpectedNodesSyntax? = nil,
_ unexpectedBetweenAttributesAndEach: UnexpectedNodesSyntax? = nil,
each: TokenSyntax? = nil,
_ unexpectedBetweenEachAndName: UnexpectedNodesSyntax? = nil,
name: TokenSyntax = .identifier("IdentifierToken"),
_ unexpectedBetweenNameAndEllipsis: UnexpectedNodesSyntax? = nil,
ellipsis: TokenSyntax? = nil,
_ unexpectedBetweenEllipsisAndColon: UnexpectedNodesSyntax? = nil,
_ unexpectedBetweenNameAndColon: UnexpectedNodesSyntax? = nil,
colon: TokenSyntax? = nil,
_ unexpectedBetweenColonAndInheritedType: UnexpectedNodesSyntax? = nil,
inheritedType: I? = nil,
Expand All @@ -10324,11 +10324,11 @@ public struct GenericParameterSyntax: SyntaxProtocol, SyntaxHashable {
let data: SyntaxData = withExtendedLifetime((SyntaxArena(), (
unexpectedBeforeAttributes,
attributes,
unexpectedBetweenAttributesAndName,
unexpectedBetweenAttributesAndEach,
each,
unexpectedBetweenEachAndName,
name,
unexpectedBetweenNameAndEllipsis,
ellipsis,
unexpectedBetweenEllipsisAndColon,
unexpectedBetweenNameAndColon,
colon,
unexpectedBetweenColonAndInheritedType,
inheritedType,
Expand All @@ -10339,11 +10339,11 @@ public struct GenericParameterSyntax: SyntaxProtocol, SyntaxHashable {
let layout: [RawSyntax?] = [
unexpectedBeforeAttributes?.raw,
attributes?.raw,
unexpectedBetweenAttributesAndName?.raw,
unexpectedBetweenAttributesAndEach?.raw,
each?.raw,
unexpectedBetweenEachAndName?.raw,
name.raw,
unexpectedBetweenNameAndEllipsis?.raw,
ellipsis?.raw,
unexpectedBetweenEllipsisAndColon?.raw,
unexpectedBetweenNameAndColon?.raw,
colon?.raw,
unexpectedBetweenColonAndInheritedType?.raw,
inheritedType?.raw,
Expand Down Expand Up @@ -10377,11 +10377,11 @@ public struct GenericParameterSyntax: SyntaxProtocol, SyntaxHashable {
leadingTrivia: Trivia? = nil,
_ unexpectedBeforeAttributes: UnexpectedNodesSyntax? = nil,
attributes: AttributeListSyntax? = nil,
_ unexpectedBetweenAttributesAndName: UnexpectedNodesSyntax? = nil,
_ unexpectedBetweenAttributesAndEach: UnexpectedNodesSyntax? = nil,
each: TokenSyntax? = nil,
_ unexpectedBetweenEachAndName: UnexpectedNodesSyntax? = nil,
name: TokenSyntax = .identifier("IdentifierToken"),
_ unexpectedBetweenNameAndEllipsis: UnexpectedNodesSyntax? = nil,
ellipsis: TokenSyntax? = nil,
_ unexpectedBetweenEllipsisAndColon: UnexpectedNodesSyntax? = nil,
_ unexpectedBetweenNameAndColon: UnexpectedNodesSyntax? = nil,
colon: TokenSyntax? = nil,
_ unexpectedBetweenColonAndInheritedType: UnexpectedNodesSyntax? = nil,
inheritedType: MissingTypeSyntax? = nil,
Expand All @@ -10395,11 +10395,11 @@ public struct GenericParameterSyntax: SyntaxProtocol, SyntaxHashable {
leadingTrivia: leadingTrivia,
unexpectedBeforeAttributes,
attributes: attributes,
unexpectedBetweenAttributesAndName,
unexpectedBetweenAttributesAndEach,
each: each,
unexpectedBetweenEachAndName,
name: name,
unexpectedBetweenNameAndEllipsis,
ellipsis: ellipsis,
unexpectedBetweenEllipsisAndColon,
unexpectedBetweenNameAndColon,
colon: colon,
unexpectedBetweenColonAndInheritedType,
inheritedType: Optional<TypeSyntax>.none,
Expand Down Expand Up @@ -10447,7 +10447,7 @@ public struct GenericParameterSyntax: SyntaxProtocol, SyntaxHashable {
return GenericParameterSyntax(newData)
}

public var unexpectedBetweenAttributesAndName: UnexpectedNodesSyntax? {
public var unexpectedBetweenAttributesAndEach: UnexpectedNodesSyntax? {
get {
return data.child(at: 2, parent: Syntax(self)).map(UnexpectedNodesSyntax.init)
}
Expand All @@ -10456,16 +10456,16 @@ public struct GenericParameterSyntax: SyntaxProtocol, SyntaxHashable {
}
}

public var name: TokenSyntax {
public var each: TokenSyntax? {
get {
return TokenSyntax(data.child(at: 3, parent: Syntax(self))!)
return data.child(at: 3, parent: Syntax(self)).map(TokenSyntax.init)
}
set(value) {
self = GenericParameterSyntax(data.replacingChild(at: 3, with: value.raw, arena: SyntaxArena()))
self = GenericParameterSyntax(data.replacingChild(at: 3, with: value?.raw, arena: SyntaxArena()))
}
}

public var unexpectedBetweenNameAndEllipsis: UnexpectedNodesSyntax? {
public var unexpectedBetweenEachAndName: UnexpectedNodesSyntax? {
get {
return data.child(at: 4, parent: Syntax(self)).map(UnexpectedNodesSyntax.init)
}
Expand All @@ -10474,16 +10474,16 @@ public struct GenericParameterSyntax: SyntaxProtocol, SyntaxHashable {
}
}

public var ellipsis: TokenSyntax? {
public var name: TokenSyntax {
get {
return data.child(at: 5, parent: Syntax(self)).map(TokenSyntax.init)
return TokenSyntax(data.child(at: 5, parent: Syntax(self))!)
}
set(value) {
self = GenericParameterSyntax(data.replacingChild(at: 5, with: value?.raw, arena: SyntaxArena()))
self = GenericParameterSyntax(data.replacingChild(at: 5, with: value.raw, arena: SyntaxArena()))
}
}

public var unexpectedBetweenEllipsisAndColon: UnexpectedNodesSyntax? {
public var unexpectedBetweenNameAndColon: UnexpectedNodesSyntax? {
get {
return data.child(at: 6, parent: Syntax(self)).map(UnexpectedNodesSyntax.init)
}
Expand Down Expand Up @@ -10550,11 +10550,11 @@ public struct GenericParameterSyntax: SyntaxProtocol, SyntaxHashable {
return .layout([
\Self.unexpectedBeforeAttributes,
\Self.attributes,
\Self.unexpectedBetweenAttributesAndName,
\Self.unexpectedBetweenAttributesAndEach,
\Self.each,
\Self.unexpectedBetweenEachAndName,
\Self.name,
\Self.unexpectedBetweenNameAndEllipsis,
\Self.ellipsis,
\Self.unexpectedBetweenEllipsisAndColon,
\Self.unexpectedBetweenNameAndColon,
\Self.colon,
\Self.unexpectedBetweenColonAndInheritedType,
\Self.inheritedType,
Expand All @@ -10573,11 +10573,11 @@ public struct GenericParameterSyntax: SyntaxProtocol, SyntaxHashable {
case 2:
return nil
case 3:
return "name"
return "parameter pack specifier"
case 4:
return nil
case 5:
return "parameter pack specifier"
return "name"
case 6:
return nil
case 7:
Expand All @@ -10603,11 +10603,11 @@ extension GenericParameterSyntax: CustomReflectable {
return Mirror(self, children: [
"unexpectedBeforeAttributes": unexpectedBeforeAttributes.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"attributes": attributes.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"unexpectedBetweenAttributesAndName": unexpectedBetweenAttributesAndName.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"unexpectedBetweenAttributesAndEach": unexpectedBetweenAttributesAndEach.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"each": each.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"unexpectedBetweenEachAndName": unexpectedBetweenEachAndName.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"name": Syntax(name).asProtocol(SyntaxProtocol.self),
"unexpectedBetweenNameAndEllipsis": unexpectedBetweenNameAndEllipsis.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"ellipsis": ellipsis.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"unexpectedBetweenEllipsisAndColon": unexpectedBetweenEllipsisAndColon.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"unexpectedBetweenNameAndColon": unexpectedBetweenNameAndColon.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"colon": colon.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"unexpectedBetweenColonAndInheritedType": unexpectedBetweenColonAndInheritedType.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
"inheritedType": inheritedType.map(Syntax.init)?.asProtocol(SyntaxProtocol.self) as Any ,
Expand Down
Loading