Generate `BuildableCollectionNodes` with `SwiftSyntaxBuilderGeneration` #506

fwcd · 2022-07-20T18:55:18Z

This PR ports the currently gyb-generated BuildableCollectionNodes to SwiftSyntaxBuilder's DSL as part of the ongoing effort to bootstrap SwiftSyntaxBuilder with SwiftSyntaxBuilderGeneration.

fwcd · 2022-07-20T18:55:43Z

@swift-ci please test

fwcd

A note on the implementation and a few ideas for (future) improvements to the DSL below

Sources/SwiftSyntaxBuilderGeneration/SyntaxUtilities.swift

Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableCollectionNodesFile.swift

fwcd · 2022-07-20T19:10:37Z

Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableCollectionNodesFile.swift

+        parameters: ParameterClause(
+          parameterList: [
+            FunctionParameter(


Having Array: ExpressibleAsParameterClause might be cool, this would be pretty analogous to #506 (comment).

Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableCollectionNodesFile.swift

ahoppen

Some thoughts inline.

Looking at this gigantic result builder, I’m wondering whether it makes sense to create the different initializers and functions in standalone functions. That way we would get rid of two nesting levels and could document the functions with what they generate.

Also, I think function calls are still pretty verbose with their TupleExprElements, but I haven’t come up with a better solution either…

Sources/SwiftSyntaxBuilderGeneration/SyntaxUtilities.swift

Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableCollectionNodesFile.swift

fwcd · 2022-07-27T16:10:09Z

Whoops, didn't intend to auto-close this :D

Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableCollectionNodesFile.swift

fwcd · 2022-08-02T20:22:11Z

I have cleaned up the template and factored out the generated functions along with some doc comments, so it should be a bit more readable now.

@swift-ci please test

Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableCollectionNodesFile.swift

fwcd · 2022-08-04T02:22:38Z

Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableCollectionNodesFile.swift

+    IfStmt(
+      conditions: OptionalBindingCondition(
+        letOrVarKeyword: .let,
+        pattern: "leadingTrivia",
+        initializer: "leadingTrivia"
+      )
+    ) {
+      ReturnStmt(expression: FunctionCallExpr(MemberAccessExpr(base: "result", name: "withLeadingTrivia")) {
+        TupleExprElement(expression: FunctionCallExpr(MemberAccessExpr(
+          base: TupleExpr {
+            SequenceExpr {
+              "leadingTrivia"
+              BinaryOperatorExpr("+")
+              TupleExpr {
+                SequenceExpr {
+                  MemberAccessExpr(base: "result", name: "leadingTrivia")
+                  BinaryOperatorExpr("??")
+                  ArrayExpr(elements: [])
+                }
+              }
+            }
+          },
+          name: "addingSpacingAfterNewlinesIfNeeded"
+        )))
+      })


Contrary to what I proposed in #506 (comment), we may have to stick with the if-let for now since the variant I proposed has slightly different semantics (the if-version will only consider result.leadingTrivia if the function parameter leadingTrivia is set). This becomes relevant as otherwise .addingSpacingAfterNewlinesIfNeeded() will generate duplicate indentation in some cases.

One alternative solution would be to use optional chaining and only apply the spacing-after-newlines to the function argument leadingTrivia:

let combinedLeadingTrivia = (leadingTrivia?.addingSpacingAfterNewlinesIfNeeded() ?? []) + (result.leadingTrivia ?? []) return combinedLeadingTrivia

instead of the current

if let leadingTrivia = leadingTrivia { return result.withLeadingTrivia((leadingTrivia + (result.leadingTrivia ?? [])).addingSpacingAfterNewlinesIfNeeded()) } else { return result }

While that seems to yield the correct result, I am not sure whether there are some edge cases where this logic breaks down (or whether we make too many assumptions about the kind of leading trivia here, e.g. whitespace trivia is 'nice' in the sense that it commutes and therefore may not exercise certain logic errors).

For this reason I decided not to make this change until we have figured that out. Any thoughts on this?

One alternative solution would be to use optional chaining and only apply the spacing-after-newlines to the function argument leadingTrivia

I think that sounds reasonable. I would suggest we discuss it in a separate PR.

fwcd · 2022-08-04T02:23:13Z

@swift-ci please test

ahoppen

One minor comment regarding the generated documentation, otherwise LGTM.

Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableCollectionNodesFile.swift

- Stub out BuildableCollectionNodes generation - Generate elements initializer in BuildableCollectionNodes - Generate combining initializer - Generate arrayLiteral initializer - Generate build method implementation - Add buildSyntax implementation - Add expressibleAs conformance method - Add createSyntaxBuildable - Generate Array conformances - Bootstrap BuildableCollectionNodes - Use FunctionSignatures in InitializerDecls - Use new IfStmt convenience init in BuildableCollectionNodesFile - Use new builder-based ExprList initializers - Use new builder-based ConditionElementList initializer - Use new VariableDecl convenience initializer - Use new SequenceExpr initializer - Factor out utility method for format-leadingTrivia params - Factor out generated functions in BuildableCollectionNodesFile - Parenthesize leading trivia correctly

fwcd · 2022-08-04T13:15:00Z

@swift-ci please test

fwcd requested a review from ahoppen as a code owner July 20, 2022 18:55

fwcd commented Jul 20, 2022

View reviewed changes

fwcd mentioned this pull request Jul 20, 2022

Conform TokenSyntax to ExpressibleByStringLiteral and ExpressibleByStringInterpolation #507

Closed

ahoppen reviewed Jul 20, 2022

View reviewed changes

fwcd force-pushed the buildable-collection-nodes-swift-syntax-gen branch from ba56542 to 4b64757 Compare July 26, 2022 14:00

fwcd marked this pull request as draft July 27, 2022 15:04

fwcd force-pushed the buildable-collection-nodes-swift-syntax-gen branch from 4b64757 to 021df63 Compare July 27, 2022 15:23

fwcd mentioned this pull request Jul 27, 2022

Make OptionalBindingCondition and MatchingPatternCondition expressible as ConditionElement #525

Merged

fwcd force-pushed the buildable-collection-nodes-swift-syntax-gen branch from 021df63 to 581042f Compare July 27, 2022 15:53

fwcd closed this in #524 Jul 27, 2022

fwcd reopened this Jul 27, 2022

fwcd force-pushed the buildable-collection-nodes-swift-syntax-gen branch from 581042f to 834ee19 Compare July 27, 2022 16:10

fwcd mentioned this pull request Jul 27, 2022

[Experimental] Make Array expressible as every collection node via dynamism #528

Closed

fwcd force-pushed the buildable-collection-nodes-swift-syntax-gen branch 2 times, most recently from 528a58c to ce4f4f3 Compare July 29, 2022 22:59

fwcd commented Jul 29, 2022

View reviewed changes

Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableCollectionNodesFile.swift Outdated Show resolved Hide resolved

fwcd force-pushed the buildable-collection-nodes-swift-syntax-gen branch from ce4f4f3 to 76fdb9d Compare August 2, 2022 20:02

fwcd marked this pull request as ready for review August 2, 2022 20:21

fwcd commented Aug 2, 2022

View reviewed changes

Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableCollectionNodesFile.swift Outdated Show resolved Hide resolved

ahoppen approved these changes Aug 3, 2022

View reviewed changes

fwcd force-pushed the buildable-collection-nodes-swift-syntax-gen branch from f2a1094 to ea88f57 Compare August 4, 2022 02:04

fwcd commented Aug 4, 2022

View reviewed changes

ahoppen approved these changes Aug 4, 2022

View reviewed changes

Sources/SwiftSyntaxBuilderGeneration/Templates/BuildableCollectionNodesFile.swift Outdated Show resolved Hide resolved

fwcd added 2 commits August 4, 2022 15:00

Fix ArrayExpr in SyntaxBuildableChild

cb49936

fwcd force-pushed the buildable-collection-nodes-swift-syntax-gen branch from fe98ad5 to 1b2af6f Compare August 4, 2022 13:14

fwcd merged commit cbdc9a4 into swiftlang:main Aug 4, 2022

fwcd deleted the buildable-collection-nodes-swift-syntax-gen branch August 4, 2022 14:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate `BuildableCollectionNodes` with `SwiftSyntaxBuilderGeneration` #506

Generate `BuildableCollectionNodes` with `SwiftSyntaxBuilderGeneration` #506

fwcd commented Jul 20, 2022

fwcd commented Jul 20, 2022

fwcd left a comment

fwcd Jul 20, 2022 •

edited

Loading

ahoppen left a comment

fwcd commented Jul 27, 2022

fwcd commented Aug 2, 2022

fwcd Aug 4, 2022

ahoppen Aug 4, 2022

fwcd commented Aug 4, 2022

ahoppen left a comment

fwcd commented Aug 4, 2022

Generate BuildableCollectionNodes with SwiftSyntaxBuilderGeneration #506

Generate BuildableCollectionNodes with SwiftSyntaxBuilderGeneration #506

Conversation

fwcd commented Jul 20, 2022

fwcd commented Jul 20, 2022

fwcd left a comment

Choose a reason for hiding this comment

fwcd Jul 20, 2022 • edited Loading

Choose a reason for hiding this comment

ahoppen left a comment

Choose a reason for hiding this comment

fwcd commented Jul 27, 2022

fwcd commented Aug 2, 2022

fwcd Aug 4, 2022

Choose a reason for hiding this comment

ahoppen Aug 4, 2022

Choose a reason for hiding this comment

fwcd commented Aug 4, 2022

ahoppen left a comment

Choose a reason for hiding this comment

fwcd commented Aug 4, 2022

Generate `BuildableCollectionNodes` with `SwiftSyntaxBuilderGeneration` #506

Generate `BuildableCollectionNodes` with `SwiftSyntaxBuilderGeneration` #506

fwcd Jul 20, 2022 •

edited

Loading