Skip to content

[BuilderTransform] Type-check buildBlock of each condition body separately from "join" operation #79617

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.

Sign up for GitHub

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 2 commits into from
Feb 28, 2025
Merged

[BuilderTransform] Type-check buildBlock of each condition body separately from "join" operation #79617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3add375
[BuilderTransform] Case: Save result of `buildBlock` into a variable …
xedin Jan 19, 2025
d70f14e
[BuilderTransform] If: Save result of `buildBlock` into a variable be…
xedin Jan 21, 2025
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
20 changes: 16 additions & 4 deletions lib/Sema/BuilderTransform.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,8 @@ class ResultBuilderTransform
}

std::pair<NullablePtr<Expr>, std::optional<UnsupportedElt>>
transform(BraceStmt *braceStmt, SmallVectorImpl<ASTNode> &newBody) {
transform(BraceStmt *braceStmt, SmallVectorImpl<ASTNode> &newBody,
bool isolateBuildBlock = false) {
SmallVector<Expr *, 4> buildBlockArguments;

auto failTransform = [&](UnsupportedElt unsupported) {
Expand Down Expand Up @@ -326,6 +327,14 @@ class ResultBuilderTransform
auto *buildBlock = builder.buildCall(
braceStmt->getStartLoc(), ctx.Id_buildBlock, buildBlockArguments,
/*argLabels=*/{});

if (isolateBuildBlock) {
auto *buildBlockVar = captureExpr(buildBlock, newBody);
return std::make_pair(
builder.buildVarRef(buildBlockVar, braceStmt->getStartLoc()),
std::nullopt);
}

return std::make_pair(buildBlock, std::nullopt);
}
}
Expand Down Expand Up @@ -502,7 +511,8 @@ class ResultBuilderTransform

auto *ifBraceStmt = cast<BraceStmt>(ifStmt->getThenStmt());

std::tie(thenVarRef, unsupported) = transform(ifBraceStmt, thenBody);
std::tie(thenVarRef, unsupported) =
transform(ifBraceStmt, thenBody, /*isolateBuildBlock=*/true);
if (unsupported) {
recordUnsupported(*unsupported);
return nullptr;
Expand Down Expand Up @@ -537,7 +547,8 @@ class ResultBuilderTransform
auto *elseBraceStmt = cast<BraceStmt>(elseStmt);
SmallVector<ASTNode> elseBody;

std::tie(elseVarRef, unsupported) = transform(elseBraceStmt, elseBody);
std::tie(elseVarRef, unsupported) = transform(
elseBraceStmt, elseBody, /*isolateBuildBlock=*/true);
if (unsupported) {
recordUnsupported(*unsupported);
return nullptr;
Expand Down Expand Up @@ -634,7 +645,8 @@ class ResultBuilderTransform
std::optional<UnsupportedElt> unsupported;
SmallVector<ASTNode, 4> newBody;

std::tie(caseVarRef, unsupported) = transform(body, newBody);
std::tie(caseVarRef, unsupported) =
transform(body, newBody, /*isolateBuildBlock=*/true);

if (unsupported) {
recordUnsupported(*unsupported);
Expand Down
20 changes: 19 additions & 1 deletion test/ConstExtraction/ExtractResultBuilders.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public enum FooBuilder {
public static func buildBlock(_ components: Component...) -> Component {
return components.flatMap { $0 }
}

public static func buildLimitedAvailability(_ component: Component) -> Component {
return component
}
Expand Down Expand Up @@ -340,6 +340,9 @@ public struct MyFooProviderInferred: FooProvider {
// CHECK-NEXT: ]
// CHECK-NEXT: }
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "element": {}
// CHECK-NEXT: }
// CHECK-NEXT: ],
// CHECK-NEXT: "elseElements": [
Expand All @@ -360,6 +363,9 @@ public struct MyFooProviderInferred: FooProvider {
// CHECK-NEXT: ]
// CHECK-NEXT: }
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "element": {}
// CHECK-NEXT: }
// CHECK-NEXT: ],
// CHECK-NEXT: "elseElements": [
Expand All @@ -378,6 +384,9 @@ public struct MyFooProviderInferred: FooProvider {
// CHECK-NEXT: ]
// CHECK-NEXT: }
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "element": {}
// CHECK-NEXT: }
// CHECK-NEXT: ]
// CHECK-NEXT: }
Expand Down Expand Up @@ -436,6 +445,9 @@ public struct MyFooProviderInferred: FooProvider {
// CHECK-NEXT: ]
// CHECK-NEXT: }
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "element": {}
// CHECK-NEXT: }
// CHECK-NEXT: ],
// CHECK-NEXT: "elseElements": []
Expand Down Expand Up @@ -499,6 +511,9 @@ public struct MyFooProviderInferred: FooProvider {
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "element": {}
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "element": {}
// CHECK-NEXT: }
// CHECK-NEXT: ],
// CHECK-NEXT: "elseElements": [
Expand All @@ -517,6 +532,9 @@ public struct MyFooProviderInferred: FooProvider {
// CHECK-NEXT: ]
// CHECK-NEXT: }
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "element": {}
// CHECK-NEXT: }
// CHECK-NEXT: ]
// CHECK-NEXT: }
Expand Down
30 changes: 30 additions & 0 deletions test/Constraints/result_builder_switch_with_vars.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,33 @@ tuplify {
value.a
}
}

tuplify { _ in
switch true {
// CHECK: (case_stmt {{.*}}
// CHECK: (pattern_named implicit type="Int" "$__builder2")
// CHECK: (declref_expr implicit type="(TupleBuilder.Type) -> (Int) -> Int" location={{.*}} range={{.*}} decl="{{.*}}buildBlock@{{.*}}" function_ref=single apply)

// CHECK: (call_expr implicit type="Either<Int, Int>" {{.*}}
// CHECK-NEXT: (dot_syntax_call_expr implicit type="(Int) -> Either<Int, Int>" {{.*}}
// CHECK-NEXT: (declref_expr implicit type="(TupleBuilder.Type) -> (Int) -> Either<Int, Int>" location={{.*}} range={{.*}} decl="{{.*}}buildEither(first:)@{{.*}}" function_ref=single apply)
// CHECK: (argument_list implicit labels="first:"
// CHECK-NEXT: (argument label="first"
// CHECK-NEXT: (load_expr implicit type="Int" {{.*}}
// CHECK-NEXT: (declref_expr implicit type="@lvalue Int" location={{.*}} range={{.*}} decl="{{.*}}.$__builder2@{{.*}}" function_ref=unapplied))))))))
case true: 0

// CHECK: (case_stmt {{.*}}
// CHECK: (pattern_named implicit type="Int" "$__builder4")
// CHECK: (declref_expr implicit type="(TupleBuilder.Type) -> (Int) -> Int" location={{.*}} range={{.*}} decl="{{.*}}buildBlock@{{.*}}" function_ref=single apply)

// CHECK: (call_expr implicit type="Either<Int, Int>" {{.*}}
// CHECK-NEXT: (dot_syntax_call_expr implicit type="(Int) -> Either<Int, Int>" {{.*}}
// CHECK-NEXT: (declref_expr implicit type="(TupleBuilder.Type) -> (Int) -> Either<Int, Int>" location={{.*}} range={{.*}} decl="{{.*}}buildEither(second:)@{{.*}}" function_ref=single apply)
// CHECK: (argument_list implicit labels="second:"
// CHECK-NEXT: (argument label="second"
// CHECK-NEXT: (load_expr implicit type="Int" {{.*}}
// CHECK-NEXT: (declref_expr implicit type="@lvalue Int" location={{.*}} range={{.*}} decl="{{.*}}.$__builder4@{{.*}}" function_ref=unapplied))))))))
case false: 1
}
}
11 changes: 5 additions & 6 deletions validation-test/Sema/result_builder_buildBlock_resolution.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
// RUN: %target-typecheck-verify-swift
// RUN: %target-typecheck-verify-swift -I %t

// This test verifies that `buildBlock` is type-checked together with enclosing context,
// which means that it's not captured into separate variable but rather used directly and
// contextual information can impact overload resolution.
// ! - Based on the result builders proposal `buildBlock` shouldn't be type-checked together with `buildOptional`.

protocol ActionIdentifier: Hashable {
}
Expand All @@ -14,11 +12,11 @@ struct ActionLookup<Identifier: ActionIdentifier> {

@resultBuilder
enum ActionLookupBuilder<Identifier: ActionIdentifier> { // expected-note 3{{'Identifier' previously declared here}}
static func buildBlock<Identifier: ActionIdentifier>(_ components: [ActionLookup<Identifier>]...) -> ActionLookup<Identifier> { // expected-warning {{generic parameter 'Identifier' shadows generic parameter from outer scope with the same name; this is an error in the Swift 6 language mode}}
static func buildBlock<Identifier: ActionIdentifier>(_ components: [ActionLookup<Identifier>]...) -> ActionLookup<Identifier> { // expected-warning {{generic parameter 'Identifier' shadows generic parameter from outer scope with the same name; this is an error in the Swift 6 language mode}} expected-note {{found this candidate}}
fatalError()
}

static func buildBlock<Identifier: ActionIdentifier>(_ components: [ActionLookup<Identifier>]...) -> [ActionLookup<Identifier>] { // expected-warning {{generic parameter 'Identifier' shadows generic parameter from outer scope with the same name; this is an error in the Swift 6 language mode}}
static func buildBlock<Identifier: ActionIdentifier>(_ components: [ActionLookup<Identifier>]...) -> [ActionLookup<Identifier>] { // expected-warning {{generic parameter 'Identifier' shadows generic parameter from outer scope with the same name; this is an error in the Swift 6 language mode}} expected-note {{found this candidate}}
[]
}

Expand All @@ -43,7 +41,8 @@ enum ActionType: String, ActionIdentifier, CaseIterable {
ActionTypeLookup(
.download
)
if true { // If condition is needed to make sure that `buildOptional` affects `buildBlock` resolution.
if true { // If condition without else is needed to make sure that `buildOptional` affects `buildBlock` resolution.
// expected-error@-1 {{ambiguous use of 'buildBlock'}}
ActionTypeLookup(
.upload
)
Expand Down