Skip to content

Fix leading trivia is not applied if raw syntax is empty #365

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 1 commit into from
Feb 25, 2022
Merged
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
24 changes: 16 additions & 8 deletions Sources/SwiftSyntax/RawSyntax.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1113,7 +1113,11 @@ final class RawSyntax: ManagedBuffer<RawSyntaxBase, RawSyntaxDataElement> {
}
}

func withLeadingTrivia(_ leadingTrivia: Trivia) -> RawSyntax {
/// Replaces the leading trivia of the first token in this syntax tree by `leadingTrivia`.
/// If the syntax tree did not contain a token and thus no trivia could be attached to it, `nil` is returned.
/// - Parameters:
/// - leadingTrivia: The trivia to attach.
func withLeadingTrivia(_ leadingTrivia: Trivia) -> RawSyntax? {
if isToken {
return RawSyntax.createAndCalcLength(
kind: formTokenKind()!,
Expand All @@ -1123,16 +1127,20 @@ final class RawSyntax: ManagedBuffer<RawSyntaxBase, RawSyntaxDataElement> {
} else {
var layout = formLayoutArray()
for (index, raw) in layout.enumerated() {
if let raw = raw {
layout[index] = raw.withLeadingTrivia(leadingTrivia)
if let raw = raw, let newRaw = raw.withLeadingTrivia(leadingTrivia) {
layout[index] = newRaw
return replacingLayout(layout)
}
}
return self
return nil
}
}

func withTrailingTrivia(_ trailingTrivia: Trivia) -> RawSyntax {
/// Replaces the trailing trivia of the first token in this syntax tree by `trailingTrivia`.
/// If the syntax tree did not contain a token and thus no trivia could be attached to it, `nil` is returned.
/// - Parameters:
/// - trailingTrivia: The trivia to attach.
func withTrailingTrivia(_ trailingTrivia: Trivia) -> RawSyntax? {
if isToken {
return RawSyntax.createAndCalcLength(
kind: formTokenKind()!,
Expand All @@ -1142,12 +1150,12 @@ final class RawSyntax: ManagedBuffer<RawSyntaxBase, RawSyntaxDataElement> {
} else {
var layout = formLayoutArray()
for (index, raw) in layout.enumerated().reversed() {
if let raw = raw {
layout[index] = raw.withTrailingTrivia(trailingTrivia)
if let raw = raw, let newRaw = raw.withTrailingTrivia(trailingTrivia) {
layout[index] = newRaw
return replacingLayout(layout)
}
}
return self
return nil
}
}

Expand Down
12 changes: 10 additions & 2 deletions Sources/SwiftSyntax/SyntaxData.swift
Original file line number Diff line number Diff line change
Expand Up @@ -356,10 +356,18 @@ struct SyntaxData {
}

func withLeadingTrivia(_ leadingTrivia: Trivia) -> SyntaxData {
return replacingSelf(raw.withLeadingTrivia(leadingTrivia))
if let raw = raw.withLeadingTrivia(leadingTrivia) {
return replacingSelf(raw)
} else {
return self
}
}

func withTrailingTrivia(_ trailingTrivia: Trivia) -> SyntaxData {
return replacingSelf(raw.withTrailingTrivia(trailingTrivia))
if let raw = raw.withTrailingTrivia(trailingTrivia) {
return replacingSelf(raw)
} else {
return self
}
}
}
2 changes: 1 addition & 1 deletion Tests/SwiftSyntaxBuilderTest/FunctionTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ final class FunctionTests: XCTestCase {
let syntax = buildable.buildSyntax(format: Format(), leadingTrivia: leadingTrivia)

XCTAssertEqual(syntax.description, """
func fibonacci(_ n: Int)-> Int{
func fibonacci(_ n: Int)-> Int{
if n <= 1{
return n
}
Expand Down
5 changes: 2 additions & 3 deletions Tests/SwiftSyntaxBuilderTest/ProtocolDeclTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ final class ProtocolDeclTests: XCTestCase {
let functionSignature = FunctionSignature(input: input, output: returnType)

let buildable = ProtocolDecl(identifier: "DeclListBuildable", attributesBuilder: { TokenSyntax.public }, membersBuilder: {
// FIXME: We need to add the `modifiersBuilder` with a non-empty value, otherwise will the builder omit newline.
FunctionDecl(identifier: .identifier("buildDeclList"), signature: functionSignature, body: nil, modifiersBuilder: { TokenSyntax.public })
FunctionDecl(identifier: .identifier("buildDeclList"), signature: functionSignature, body: nil, modifiersBuilder: { })
})

let syntax = buildable.buildSyntax(format: Format())
Expand All @@ -23,7 +22,7 @@ final class ProtocolDeclTests: XCTestCase {

XCTAssertEqual(text, """
public protocol DeclListBuildable{
public func buildDeclList(format: Format, leadingTrivia: Trivia?)-> [DeclSyntax]
func buildDeclList(format: Format, leadingTrivia: Trivia?)-> [DeclSyntax]
}
""")
}
Expand Down