SwiftSyntax: allow any Syntax nodes to access their leading/trailing trivia. #15278
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…trivia. Although libSyntax is designed in a way that trivia is attached to tokens, we shouldn't restrict clients to access trivia only from a token. An example can be doc-comment, which conceptually attaches to a declaration rather than the start token of a declaration, like at-attributes.
|
@swift-ci please smoke test |
|
@harlanhaskins @rintaro Any objection to this? |
| PositionTests.test("Trivias") { | ||
| expectDoesNotThrow({ | ||
| var l = [CodeBlockItemSyntax]() | ||
| let leading = Trivia.newlines(1).appending(TriviaPiece.backticks(1)) |
There was a problem hiding this comment.
This could be cleaner as:
let leading = Trivia(pieces: [
.newlines(1),
.backticks(1),
.docLineComment("/// some comment")
])| let leading = Trivia.newlines(1).appending(TriviaPiece.backticks(1)) | ||
| .appending(TriviaPiece.docLineComment("/// some comment")) | ||
| let trailing = Trivia.docLineComment("/// This is comment\n") | ||
| let idx = 5 |
There was a problem hiding this comment.
Probably would be a good idea to Make the ReturnStmt here then just say
let l = [CodeBlockItemSyntax](repeating: returnStmt, count: 5)| for _ in 0...idx { | ||
| l.append(SyntaxFactory.makeCodeBlockItem( | ||
| item: SyntaxFactory.makeReturnStmt( | ||
| returnKeyword: SyntaxFactory.makeToken(.returnKeyword, presence: .present) |
There was a problem hiding this comment.
ReturnStmtSyntax {
$0.useReturnKeyword(
SyntaxFactory.makeReturnKeyword(
leadingTrivia: leading,
trailingTrivia: trailing))
}
|
@swift-ci please smoke test |
tools/SwiftSyntax/Syntax.swift
Outdated
| /// The textual byte length of this node exluding leading and trailing trivia. | ||
| public var byteSizeAfterTrimmingTrivia: Int { | ||
| return data.byteSize - | ||
| (leadingTrivia == nil ? 0 : leadingTrivia!.byteSize) - |
There was a problem hiding this comment.
These should probably be leadingTrivia?.byteSize ?? 0 to avoid the force-unwrap.
|
@swift-ci please smoke test |
|
🎉 |
maldahleh
pushed a commit
to maldahleh/swift
that referenced
this pull request
Oct 26, 2020
…trivia. (swiftlang#15278) Although libSyntax is designed in a way that trivia is attached to tokens, we shouldn't restrict clients to access trivia only from a token. An example can be doc-comment, which conceptually attaches to a declaration rather than the start token of a declaration, like at-attributes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Although libSyntax is designed in a way that trivia is attached to
tokens, we shouldn't restrict clients to access trivia only from a token.
An example can be doc-comment, which conceptually attaches to a declaration rather
than the start token of a declaration, like at-attributes.