Skip to content

[5.9] Update CodeGeneration + some CodeGeneration formatting improvements #1572

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

Closed
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion CodeGeneration/Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ let package = Package(
.executable(name: "generate-swiftsyntax", targets: ["generate-swiftsyntax"])
],
dependencies: [
.package(url: "https://github.com/apple/swift-syntax.git", revision: "39b3336c3f3bfcd4ddbcbf6a111d8814ffe542f3"),
.package(url: "https://github.com/apple/swift-syntax.git", revision: "277498735e15bdd61f0094fc1896abe0edd6bba0"),
.package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMinor(from: "1.2.2")),
],
targets: [
Expand Down
12 changes: 6 additions & 6 deletions CodeGeneration/Sources/Utils/CodeGenerationFormat.swift
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public class CodeGenerationFormat: BasicFormat {

public override func visit(_ node: MemberDeclListItemSyntax) -> MemberDeclListItemSyntax {
let formatted = super.visit(node)
if node.indexInParent != 0 && !node.decl.is(EnumCaseDeclSyntax.self) {
if node != node.parent?.children(viewMode: .sourceAccurate).first?.as(MemberDeclListItemSyntax.self) && !node.decl.is(EnumCaseDeclSyntax.self) {
return ensuringTwoLeadingNewlines(node: formatted)
} else {
return formatted
Expand All @@ -92,10 +92,10 @@ public class CodeGenerationFormat: BasicFormat {
}

private func ensuringTwoLeadingNewlines<NodeType: SyntaxProtocol>(node: NodeType) -> NodeType {
if node.leadingTrivia?.first?.isNewline ?? false {
return node.with(\.leadingTrivia, indentedNewline + (node.leadingTrivia ?? []))
if node.leadingTrivia.first?.isNewline ?? false {
return node.with(\.leadingTrivia, indentedNewline + node.leadingTrivia)
} else {
return node.with(\.leadingTrivia, indentedNewline + indentedNewline + (node.leadingTrivia ?? []))
return node.with(\.leadingTrivia, indentedNewline + indentedNewline + node.leadingTrivia)
}
}

Expand All @@ -105,10 +105,10 @@ public class CodeGenerationFormat: BasicFormat {
self.visit($0).as(SyntaxType.self)!
}
formattedChildren = formattedChildren.map {
if $0.leadingTrivia?.first?.isNewline == true {
if $0.leadingTrivia.first?.isNewline == true {
return $0
} else {
return $0.with(\.leadingTrivia, indentedNewline + ($0.leadingTrivia ?? []))
return $0.with(\.leadingTrivia, indentedNewline + $0.leadingTrivia)
}
}
indentationLevel -= 1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,10 @@ let parserEntryFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {

let existingUnexpected: [RawSyntax]
if let unexpectedNode = layout.children[layout.children.count - 1] {
precondition(unexpectedNode.is(RawUnexpectedNodesSyntax.self))
existingUnexpected = unexpectedNode.as(RawUnexpectedNodesSyntax.self).elements
precondition(unexpectedNode.is(RawUnexpectedNodesSyntax.self))
existingUnexpected = unexpectedNode.as(RawUnexpectedNodesSyntax.self).elements
} else {
existingUnexpected = []
existingUnexpected = []
}
let unexpected = RawUnexpectedNodesSyntax(elements: existingUnexpected + remainingTokens, arena: self.arena)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,11 +169,11 @@ let rawSyntaxNodesFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
public init(elements: [\(raw: element)], arena: __shared SyntaxArena) {
let raw = RawSyntax.makeLayout(
kind: .\(raw: node.swiftSyntaxKind), uninitializedCount: elements.count, arena: arena) { layout in
guard var ptr = layout.baseAddress else { return }
for elem in elements {
ptr.initialize(to: elem.raw)
ptr += 1
}
guard var ptr = layout.baseAddress else { return }
for elem in elements {
ptr.initialize(to: elem.raw)
ptr += 1
}
}
self.init(unchecked: raw)
}
Expand All @@ -183,7 +183,7 @@ let rawSyntaxNodesFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
DeclSyntax(
"""
public var elements: [Raw\(raw: node.collectionElementType.syntaxBaseName)] {
layoutView.children.map { Raw\(raw: node.collectionElementType.syntaxBaseName)(raw: $0!) }
layoutView.children.map { Raw\(raw: node.collectionElementType.syntaxBaseName)(raw: $0!) }
}
"""
)
Expand All @@ -193,15 +193,15 @@ let rawSyntaxNodesFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
let params = FunctionParameterListSyntax {
for child in node.children {
FunctionParameterSyntax(
firstName: child.isUnexpectedNodes ? .wildcardToken(trailingTrivia: .space) : nil,
secondName: .identifier(child.swiftName),
firstName: child.isUnexpectedNodes ? .wildcardToken(trailingTrivia: .space) : .identifier(child.swiftName),
secondName: child.isUnexpectedNodes ? .identifier(child.swiftName) : nil,
colon: .colonToken(),
type: child.rawParameterType,
defaultArgument: child.isUnexpectedNodes ? child.defaultInitialization : nil
)
}

FunctionParameterSyntax("arena: __shared SyntaxArena", for: .functionParameters)
FunctionParameterSyntax("arena: __shared SyntaxArena")
}
try InitializerDeclSyntax("public init(\(params))") {
if !node.children.isEmpty {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,18 @@ let rawSyntaxValidationFile = try! SourceFileSyntax(leadingTrivia: copyrightHead
DeclSyntax(
#"""
enum TokenChoice: CustomStringConvertible {
case keyword(StaticString)
case tokenKind(RawTokenKind)
case keyword(StaticString)
case tokenKind(RawTokenKind)

var description: String {
switch self {
case .keyword(let keyword):
return "keyword('\(keyword)')"
case .tokenKind(let kind):
return "\(kind)"
}
}
}
var description: String {
switch self {
case .keyword(let keyword):
return "keyword('\(keyword)')"
case .tokenKind(let kind):
return "\(kind)"
}
}
}
"""#
)

Expand Down Expand Up @@ -76,7 +76,7 @@ let rawSyntaxValidationFile = try! SourceFileSyntax(leadingTrivia: copyrightHead
return (file, line)
case .tokenMismatch(expectedTokenChoices: _, actualKind: _, actualText: _, file: let file, line: let line):
return (file, line)
}
}
}
}
"""#
Expand Down Expand Up @@ -156,13 +156,13 @@ let rawSyntaxValidationFile = try! SourceFileSyntax(leadingTrivia: copyrightHead

DeclSyntax(
#"""
func assertNoError(_ nodeKind: SyntaxKind, _ index: Int, _ error: ValidationError?) {
if let error = error {
let (file, line) = error.fileAndLine
assertionFailure("""
Error validating child at index \(index) of \(nodeKind):
\(error.description)
""", file: file, line: line)
func assertNoError(_ nodeKind: SyntaxKind, _ index: Int, _ error: ValidationError?) {
if let error = error {
let (file, line) = error.fileAndLine
assertionFailure("""
Error validating child at index \(index) of \(nodeKind):
\(error.description)
""", file: file, line: line)
}
}
"""#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -191,13 +191,12 @@ let syntaxCollectionsFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
/// - Parameter layout: The new list of raw syntax nodes underlying this
/// collection.
/// - Returns: A new `\(raw: node.name)` with the new layout underlying it.
internal func replacingLayout(
_ layout: [RawSyntax?]) -> \(raw: node.name) {
let arena = SyntaxArena()
let newRaw = layoutView.replacingLayout(with: layout, arena: arena)
let newData = data.replacingSelf(newRaw, arena: arena)
return \(raw: node.name)(newData)
}
internal func replacingLayout(_ layout: [RawSyntax?]) -> \(raw: node.name) {
let arena = SyntaxArena()
let newRaw = layoutView.replacingLayout(with: layout, arena: arena)
let newData = data.replacingSelf(newRaw, arena: arena)
return \(raw: node.name)(newData)
}
"""
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,18 +66,20 @@ func syntaxNode(emitKind: String) -> SourceFileSyntax {
)

try! InitializerDeclSyntax("\(node.generateInitializerDeclHeader(optionalBaseAsMissing: false))") {
let parameters = FunctionParameterListSyntax {
let parameters = ClosureParameterListSyntax {
for child in node.children {
FunctionParameterSyntax(firstName: "\(raw: child.swiftName)")
ClosureParameterSyntax(firstName: .identifier(child.swiftName))
}
}

let closureSignature = ClosureSignatureSyntax(
input: .input(
ParameterClauseSyntax {
FunctionParameterSyntax(firstName: .identifier("arena"))
FunctionParameterSyntax(firstName: .wildcardToken())
}
ClosureParameterClauseSyntax(
parameterList: ClosureParameterListSyntax {
ClosureParameterSyntax(firstName: .identifier("arena"))
ClosureParameterSyntax(firstName: .wildcardToken())
}
)
)
)
let layoutList = ArrayExprSyntax {
Expand Down Expand Up @@ -107,8 +109,12 @@ func syntaxNode(emitKind: String) -> SourceFileSyntax {
DeclSyntax(
"""
let raw = RawSyntax.makeLayout(
kind: SyntaxKind.\(raw: node.swiftSyntaxKind), from: layout, arena: arena,
leadingTrivia: leadingTrivia, trailingTrivia: trailingTrivia)
kind: SyntaxKind.\(raw: node.swiftSyntaxKind),
from: layout,
arena: arena,
leadingTrivia: leadingTrivia,
trailingTrivia: trailingTrivia
)
"""
)
}
Expand Down Expand Up @@ -384,13 +390,13 @@ fileprivate extension Node {
}

let params = FunctionParameterListSyntax {
FunctionParameterSyntax("leadingTrivia: Trivia? = nil", for: .functionParameters)
FunctionParameterSyntax("leadingTrivia: Trivia? = nil")

for child in children {
createFunctionParameterSyntax(for: child)
}

FunctionParameterSyntax("trailingTrivia: Trivia? = nil", for: .functionParameters)
FunctionParameterSyntax("trailingTrivia: Trivia? = nil")
.with(\.leadingTrivia, .newline)
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ let triviaPiecesFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
) {
for trivia in TRIVIAS {
if trivia.isCollection {
DeclSyntax(" case \(raw: trivia.enumCaseName)(Int)")
DeclSyntax("case \(raw: trivia.enumCaseName)(Int)")

} else {
DeclSyntax("case \(raw: trivia.enumCaseName)(SyntaxText)")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,7 @@ private func createConvenienceInitializer(node: Node) throws -> InitializerDeclS
produceExpr = ExprSyntax("\(raw: child.swiftName)Builder()")
}
builderParameters.append(
FunctionParameterSyntax(
"@\(raw: builderInitializableType.resultBuilderBaseName) \(raw: child.swiftName)Builder: () throws-> \(raw: builderInitializableType.syntax)",
for: .functionParameters
)
FunctionParameterSyntax("@\(raw: builderInitializableType.resultBuilderBaseName) \(raw: child.swiftName)Builder: () throws-> \(raw: builderInitializableType.syntax)")
)
} else {
produceExpr = convertFromSyntaxProtocolToSyntaxType(child: child)
Expand All @@ -95,11 +92,11 @@ private func createConvenienceInitializer(node: Node) throws -> InitializerDeclS
}

let params = ParameterClauseSyntax {
FunctionParameterSyntax("leadingTrivia: Trivia? = nil", for: .functionParameters)
FunctionParameterSyntax("leadingTrivia: Trivia? = nil")
for param in normalParameters + builderParameters {
param
}
FunctionParameterSyntax("trailingTrivia: Trivia? = nil", for: .functionParameters)
FunctionParameterSyntax("trailingTrivia: Trivia? = nil")
}

return try InitializerDeclSyntax(
Expand Down
Loading