Skip to content

[Async Refactoring] Cosmetic Improvements to "Add Async Wrapper" Refactoring #38259

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 1 commit into from
Jul 6, 2021
Merged

[Async Refactoring] Cosmetic Improvements to "Add Async Wrapper" Refactoring #38259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 24 additions & 10 deletions lib/IDE/Refactoring.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5924,17 +5924,18 @@ class AsyncConverter : private SourceEntityWalker {

OS << "await ";

// withChecked[Throwing]Continuation { cont in
// withChecked[Throwing]Continuation { continuation in
if (TopHandler.HasError) {
OS << "withCheckedThrowingContinuation";
} else {
OS << "withCheckedContinuation";
}
OS << " " << tok::l_brace << " cont " << tok::kw_in << "\n";
OS << " " << tok::l_brace << " continuation " << tok::kw_in << "\n";

// fnWithHandler(args...) { ... }
auto ClosureStr = getAsyncWrapperCompletionClosure("cont", TopHandler);
addForwardingCallTo(FD, TopHandler, /*HandlerReplacement*/ ClosureStr);
auto ClosureStr =
getAsyncWrapperCompletionClosure("continuation", TopHandler);
addForwardingCallTo(FD, TopHandler, /*HandlerReplacement=*/ClosureStr);

OS << tok::r_brace << "\n"; // end continuation closure
OS << tok::r_brace << "\n"; // end function body
Expand Down Expand Up @@ -5998,21 +5999,21 @@ class AsyncConverter : private SourceEntityWalker {
std::string OutputStr;
llvm::raw_string_ostream OS(OutputStr);

OS << " " << tok::l_brace; // start closure
OS << tok::l_brace; // start closure

// Prepare parameter names for the closure.
auto SuccessParams = HandlerDesc.getSuccessParams();
SmallVector<SmallString<4>, 2> SuccessParamNames;
for (auto idx : indices(SuccessParams)) {
SuccessParamNames.emplace_back("res");
SuccessParamNames.emplace_back("result");

// If we have multiple success params, number them e.g res1, res2...
if (SuccessParams.size() > 1)
SuccessParamNames.back().append(std::to_string(idx + 1));
}
Optional<SmallString<4>> ErrName;
if (HandlerDesc.getErrorParam())
ErrName.emplace("err");
ErrName.emplace("error");

auto HasAnyParams = !SuccessParamNames.empty() || ErrName;
if (HasAnyParams)
Expand Down Expand Up @@ -6044,8 +6045,21 @@ class AsyncConverter : private SourceEntityWalker {
OS << tok::kw_if << " " << tok::kw_let << " ";
OS << *ErrName << " " << tok::equal << " " << *ErrName << " ";
OS << tok::l_brace << "\n";
for (auto Idx : indices(SuccessParamNames)) {
auto &Name = SuccessParamNames[Idx];
auto ParamTy = SuccessParams[Idx].getParameterType();
if (!HandlerDesc.shouldUnwrap(ParamTy))
continue;

// assert(res == nil, "Expected nil-success param 'res' for non-nil
// error")
OS << "assert" << tok::l_paren << Name << " == " << tok::kw_nil;
OS << tok::comma << " \"Expected nil success param '" << Name;
OS << "' for non-nil error\"";
OS << tok::r_paren << "\n";
}

// cont.resume(throwing: err)
// continuation.resume(throwing: err)
OS << ContName << tok::period << "resume" << tok::l_paren;
OS << "throwing" << tok::colon << " " << *ErrName;
OS << tok::r_paren << "\n";
Expand Down Expand Up @@ -6077,15 +6091,15 @@ class AsyncConverter : private SourceEntityWalker {
OS << tok::r_brace << "\n";
}

// cont.resume(returning: (res1, res2, ...))
// continuation.resume(returning: (res1, res2, ...))
OS << ContName << tok::period << "resume" << tok::l_paren;
OS << "returning" << tok::colon << " ";
addTupleOf(SuccessParamNames, OS, [&](auto Ref) { OS << Ref; });
OS << tok::r_paren << "\n";
break;
}
case HandlerType::RESULT: {
// cont.resume(with: res)
// continuation.resume(with: res)
assert(SuccessParamNames.size() == 1);
OS << ContName << tok::period << "resume" << tok::l_paren;
OS << "with" << tok::colon << " " << SuccessParamNames[0];
Expand Down
106 changes: 55 additions & 51 deletions test/refactoring/ConvertAsync/convert_async_wrapper.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ func foo1(_ completion: @escaping () -> Void) {}
// FOO1-EMPTY:
// FOO1-NEXT: convert_async_wrapper.swift [[# @LINE-8]]:49 -> [[# @LINE-8]]:49
// FOO1-NEXT: func foo1() async {
// FOO1-NEXT: return await withCheckedContinuation { cont in
// FOO1-NEXT: return await withCheckedContinuation { continuation in
// FOO1-NEXT: foo1() {
// FOO1-NEXT: cont.resume(returning: ())
// FOO1-NEXT: continuation.resume(returning: ())
// FOO1-NEXT: }
// FOO1-NEXT: }
// FOO1-NEXT: }
Expand All @@ -33,9 +33,9 @@ func foo2(arg: String, _ completion: @escaping (String) -> Void) {}
// FOO2-EMPTY:
// FOO2-NEXT: convert_async_wrapper.swift [[# @LINE-8]]:68 -> [[# @LINE-8]]:68
// FOO2: func foo2(arg: String) async -> String {
// FOO2-NEXT: return await withCheckedContinuation { cont in
// FOO2-NEXT: foo2(arg: arg) { res in
// FOO2-NEXT: cont.resume(returning: res)
// FOO2-NEXT: return await withCheckedContinuation { continuation in
// FOO2-NEXT: foo2(arg: arg) { result in
// FOO2-NEXT: continuation.resume(returning: result)
// FOO2-NEXT: }
// FOO2-NEXT: }
// FOO2-NEXT: }
Expand All @@ -44,9 +44,9 @@ func foo2(arg: String, _ completion: @escaping (String) -> Void) {}
func foo3(arg: String, _ arg2: Int, _ completion: @escaping (String?) -> Void) {}

// FOO3: func foo3(arg: String, _ arg2: Int) async -> String? {
// FOO3-NEXT: return await withCheckedContinuation { cont in
// FOO3-NEXT: foo3(arg: arg, arg2) { res in
// FOO3-NEXT: cont.resume(returning: res)
// FOO3-NEXT: return await withCheckedContinuation { continuation in
// FOO3-NEXT: foo3(arg: arg, arg2) { result in
// FOO3-NEXT: continuation.resume(returning: result)
// FOO3-NEXT: }
// FOO3-NEXT: }
// FOO3-NEXT: }
Expand All @@ -55,13 +55,13 @@ func foo3(arg: String, _ arg2: Int, _ completion: @escaping (String?) -> Void) {
func foo4(_ completion: @escaping (Error?) -> Void) {}

// FOO4: func foo4() async throws {
// FOO4-NEXT: return try await withCheckedThrowingContinuation { cont in
// FOO4-NEXT: foo4() { err in
// FOO4-NEXT: if let err = err {
// FOO4-NEXT: cont.resume(throwing: err)
// FOO4-NEXT: return try await withCheckedThrowingContinuation { continuation in
// FOO4-NEXT: foo4() { error in
// FOO4-NEXT: if let error = error {
// FOO4-NEXT: continuation.resume(throwing: error)
// FOO4-NEXT: return
// FOO4-NEXT: }
// FOO4-NEXT: cont.resume(returning: ())
// FOO4-NEXT: continuation.resume(returning: ())
// FOO4-NEXT: }
// FOO4-NEXT: }
// FOO4-NEXT: }
Expand All @@ -71,9 +71,9 @@ func foo4(_ completion: @escaping (Error?) -> Void) {}
func foo5(_ completion: @escaping (Error) -> Void) {}

// FOO5: func foo5() async -> Error {
// FOO5-NEXT: return await withCheckedContinuation { cont in
// FOO5-NEXT: foo5() { res in
// FOO5-NEXT: cont.resume(returning: res)
// FOO5-NEXT: return await withCheckedContinuation { continuation in
// FOO5-NEXT: foo5() { result in
// FOO5-NEXT: continuation.resume(returning: result)
// FOO5-NEXT: }
// FOO5-NEXT: }
// FOO5-NEXT: }
Expand All @@ -82,16 +82,17 @@ func foo5(_ completion: @escaping (Error) -> Void) {}
func foo6(_ completion: @escaping (String?, Error?) -> Void) {}

// FOO6: func foo6() async throws -> String {
// FOO6-NEXT: return try await withCheckedThrowingContinuation { cont in
// FOO6-NEXT: foo6() { res, err in
// FOO6-NEXT: if let err = err {
// FOO6-NEXT: cont.resume(throwing: err)
// FOO6-NEXT: return try await withCheckedThrowingContinuation { continuation in
// FOO6-NEXT: foo6() { result, error in
// FOO6-NEXT: if let error = error {
// FOO6-NEXT: assert(result == nil, "Expected nil success param 'result' for non-nil error")
// FOO6-NEXT: continuation.resume(throwing: error)
// FOO6-NEXT: return
// FOO6-NEXT: }
// FOO6-NEXT: guard let res = res else {
// FOO6-NEXT: fatalError("Expected non-nil success param 'res' for nil error")
// FOO6-NEXT: guard let result = result else {
// FOO6-NEXT: fatalError("Expected non-nil success param 'result' for nil error")
// FOO6-NEXT: }
// FOO6-NEXT: cont.resume(returning: res)
// FOO6-NEXT: continuation.resume(returning: result)
// FOO6-NEXT: }
// FOO6-NEXT: }
// FOO6-NEXT: }
Expand All @@ -100,16 +101,17 @@ func foo6(_ completion: @escaping (String?, Error?) -> Void) {}
func foo7(_ completion: @escaping (String?, Int, Error?) -> Void) {}

// FOO7: func foo7() async throws -> (String, Int) {
// FOO7-NEXT: return try await withCheckedThrowingContinuation { cont in
// FOO7-NEXT: foo7() { res1, res2, err in
// FOO7-NEXT: if let err = err {
// FOO7-NEXT: cont.resume(throwing: err)
// FOO7-NEXT: return try await withCheckedThrowingContinuation { continuation in
// FOO7-NEXT: foo7() { result1, result2, error in
// FOO7-NEXT: if let error = error {
// FOO7-NEXT: assert(result1 == nil, "Expected nil success param 'result1' for non-nil error")
// FOO7-NEXT: continuation.resume(throwing: error)
// FOO7-NEXT: return
// FOO7-NEXT: }
// FOO7-NEXT: guard let res1 = res1 else {
// FOO7-NEXT: fatalError("Expected non-nil success param 'res1' for nil error")
// FOO7-NEXT: guard let result1 = result1 else {
// FOO7-NEXT: fatalError("Expected non-nil success param 'result1' for nil error")
// FOO7-NEXT: }
// FOO7-NEXT: cont.resume(returning: (res1, res2))
// FOO7-NEXT: continuation.resume(returning: (result1, result2))
// FOO7-NEXT: }
// FOO7-NEXT: }
// FOO7-NEXT: }
Expand All @@ -118,19 +120,21 @@ func foo7(_ completion: @escaping (String?, Int, Error?) -> Void) {}
func foo8(_ completion: @escaping (String?, Int?, Error?) -> Void) {}

// FOO8: func foo8() async throws -> (String, Int) {
// FOO8-NEXT: return try await withCheckedThrowingContinuation { cont in
// FOO8-NEXT: foo8() { res1, res2, err in
// FOO8-NEXT: if let err = err {
// FOO8-NEXT: cont.resume(throwing: err)
// FOO8-NEXT: return try await withCheckedThrowingContinuation { continuation in
// FOO8-NEXT: foo8() { result1, result2, error in
// FOO8-NEXT: if let error = error {
// FOO8-NEXT: assert(result1 == nil, "Expected nil success param 'result1' for non-nil error")
// FOO8-NEXT: assert(result2 == nil, "Expected nil success param 'result2' for non-nil error")
// FOO8-NEXT: continuation.resume(throwing: error)
// FOO8-NEXT: return
// FOO8-NEXT: }
// FOO8-NEXT: guard let res1 = res1 else {
// FOO8-NEXT: fatalError("Expected non-nil success param 'res1' for nil error")
// FOO8-NEXT: guard let result1 = result1 else {
// FOO8-NEXT: fatalError("Expected non-nil success param 'result1' for nil error")
// FOO8-NEXT: }
// FOO8-NEXT: guard let res2 = res2 else {
// FOO8-NEXT: fatalError("Expected non-nil success param 'res2' for nil error")
// FOO8-NEXT: guard let result2 = result2 else {
// FOO8-NEXT: fatalError("Expected non-nil success param 'result2' for nil error")
// FOO8-NEXT: }
// FOO8-NEXT: cont.resume(returning: (res1, res2))
// FOO8-NEXT: continuation.resume(returning: (result1, result2))
// FOO8-NEXT: }
// FOO8-NEXT: }
// FOO8-NEXT: }
Expand All @@ -139,9 +143,9 @@ func foo8(_ completion: @escaping (String?, Int?, Error?) -> Void) {}
func foo9(_ completion: @escaping (Result<String, Error>) -> Void) {}

// FOO9: func foo9() async throws -> String {
// FOO9-NEXT: return try await withCheckedThrowingContinuation { cont in
// FOO9-NEXT: foo9() { res in
// FOO9-NEXT: cont.resume(with: res)
// FOO9-NEXT: return try await withCheckedThrowingContinuation { continuation in
// FOO9-NEXT: foo9() { result in
// FOO9-NEXT: continuation.resume(with: result)
// FOO9-NEXT: }
// FOO9-NEXT: }
// FOO9-NEXT: }
Expand All @@ -150,9 +154,9 @@ func foo9(_ completion: @escaping (Result<String, Error>) -> Void) {}
func foo10(arg: Int, _ completion: @escaping (Result<(String, Int), Error>) -> Void) {}

// FOO10: func foo10(arg: Int) async throws -> (String, Int) {
// FOO10-NEXT: return try await withCheckedThrowingContinuation { cont in
// FOO10-NEXT: foo10(arg: arg) { res in
// FOO10-NEXT: cont.resume(with: res)
// FOO10-NEXT: return try await withCheckedThrowingContinuation { continuation in
// FOO10-NEXT: foo10(arg: arg) { result in
// FOO10-NEXT: continuation.resume(with: result)
// FOO10-NEXT: }
// FOO10-NEXT: }
// FOO10-NEXT: }
Expand All @@ -161,9 +165,9 @@ func foo10(arg: Int, _ completion: @escaping (Result<(String, Int), Error>) -> V
func foo11(completion: @escaping (Result<String, Never>) -> Void) {}

// FOO11: func foo11() async -> String {
// FOO11-NEXT: return await withCheckedContinuation { cont in
// FOO11-NEXT: foo11() { res in
// FOO11-NEXT: cont.resume(with: res)
// FOO11-NEXT: return await withCheckedContinuation { continuation in
// FOO11-NEXT: foo11() { result in
// FOO11-NEXT: continuation.resume(with: result)
// FOO11-NEXT: }
// FOO11-NEXT: }
// FOO11-NEXT: }
Expand All @@ -172,9 +176,9 @@ func foo11(completion: @escaping (Result<String, Never>) -> Void) {}
func foo12(completion: @escaping (Result<String, CustomError>) -> Void) {}

// FOO12: func foo12() async throws -> String {
// FOO12-NEXT: return try await withCheckedThrowingContinuation { cont in
// FOO12-NEXT: foo12() { res in
// FOO12-NEXT: cont.resume(with: res)
// FOO12-NEXT: return try await withCheckedThrowingContinuation { continuation in
// FOO12-NEXT: foo12() { result in
// FOO12-NEXT: continuation.resume(with: result)
// FOO12-NEXT: }
// FOO12-NEXT: }
// FOO12-NEXT: }