Generate BuildableNodes with SwiftSyntaxBuilderGeneration
#555
Conversation
This file contains 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
fwcd
commented
Aug 4, 2022
There was a problem hiding this comment.
Two notes on the implementation below. Another thing that we might want to look into is producing nicer formatting for very long parameter lists, for example by inserting .newline trivias:
func someFunction(
first: First,
second: Second,
third: Third
)instead of
func someFunction(first: First, second: Second, third: Third)This would, if handled generically, be out-of-scope for this PR, but ideas or thoughts on this are of course welcome.
Comment on lines
85
to
108
|
|
||
| /// Generate the `create...` function for an `ExpressibleAs...` conformance. | ||
| func createExpressibleAsCreateFunction(type: SyntaxBuildableType, additionalDocComments: [String] = []) -> FunctionDecl { | ||
| FunctionDecl( | ||
| leadingTrivia: ([ | ||
| "/// Conformance to `\(type.expressibleAsBaseName)`.", | ||
| ] + additionalDocComments).map { .docLineComment($0) + .newline }.reduce([], +), | ||
| modifiers: [TokenSyntax.public], | ||
| identifier: .identifier("create\(type.buildableBaseName)"), | ||
| signature: FunctionSignature( | ||
| input: ParameterClause(), | ||
| output: type.buildable | ||
| ) | ||
| ) { | ||
| ReturnStmt(expression: "self") | ||
| } | ||
| } | ||
|
|
||
| /// Generate the `create...` function for an `ExpressibleAs...` conformance | ||
| /// that includes an explanation as to how the function disambiguates a conformance. | ||
| func createDisambiguatingExpressibleAsCreateFunction(type: SyntaxBuildableType, baseType: SyntaxBuildableType) -> FunctionDecl { | ||
| createExpressibleAsCreateFunction(type: baseType, additionalDocComments: [ | ||
| "/// `\(type.buildableBaseName)` may conform to `\(baseType.expressibleAsBaseName)` via different `ExpressibleAs*` paths.", | ||
| "/// Thus, there are multiple default implementations of `create\(baseType.buildableBaseName)`, some of which perform conversions", | ||
| "/// through `ExpressibleAs*` protocols. To resolve the ambiguity, provie a fixed implementation that doesn't perform any conversions.", | ||
| ]) | ||
| } |
There was a problem hiding this comment.
This PR factors out the create... functions generated for the ExpressibleAs... conformances. This is particularly nice since we can share a lot of logic between BuildableNodes and BuildableCollectionNodes, including this lengthy doc comment that explains how the function disambiguates the implementation.
Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableNodesFile.swift
Outdated
Show resolved
Hide resolved
fwcd
force-pushed
the
buildable-nodes-swift-syntax-gen
branch
from
57b91b1
to
3504588
Compare
This was referenced Aug 11, 2022
fwcd
force-pushed
the
buildable-nodes-swift-syntax-gen
branch
4 times, most recently
from
e55191b
to
d34dac9
Compare
fwcd
force-pushed
the
buildable-nodes-swift-syntax-gen
branch
from
d34dac9
to
b006e6e
Compare
|
@swift-ci please test |
ahoppen
approved these changes
Aug 16, 2022
Sources/generate-swift-syntax-builder/Templates/BuildableNodesFile.swift
Outdated
Show resolved
Hide resolved
Sources/generate-swift-syntax-builder/Templates/BuildableNodesFile.swift
Show resolved
Hide resolved
Sources/generate-swift-syntax-builder/Templates/BuildableNodesFile.swift
Show resolved
Hide resolved
- Set up BuildableNodesFile - Generate BuildableNodes members - Use ...BaseName where needed in BuildableNodesFile - Generate default initializer in BuildableNodes fully - Disable assert stmt generation until swiftlang#549 is fixed - Generate convenience initializer parameters - Generate convenience initializer declaration - Use ParameterClause builder initializer - Generate initializer delegations - Generate build method in BuildableNodes - Generate build base type method in BuildableNodes - Generate expressible-as conformance in BuildableNodes - Generate base type ExpressibleAs conformance - Generate disambiguating conformances in BuildableNodes - Generate withTrailingComma function in BuildableNodes - Escape token names in backticks - Bootstrap BuildableNodes - Replace deprecated SyntaxFactory in BuildableNodesFile - Resolve style issues
fwcd
force-pushed
the
buildable-nodes-swift-syntax-gen
branch
from
b006e6e
to
e16cb8b
Compare
|
@swift-ci please test |
2 tasks
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.
This PR ports the currently gyb-generated
BuildableNodestoSwiftSyntaxBuilder's DSL as part of the ongoing effort to bootstrapSwiftSyntaxBuilderwithSwiftSyntaxBuilderGeneration.Currently blocked on
SwiftSyntaxBuilderGeneration'sNode#571resultBuilderBaseName#574To do:
BuildableNodesusingSwiftSyntaxBuilderGenerationPackage.swift)