Merge pull request swiftlang#32285 from CodaFi/escape-velocity

[Refactoring] Print @escaping For Closures In Generated Memberwise Initializer

Author: CodaFi

lib/IDE/Refactoring.cpp

@@ -3126,7 +3126,7 @@ struct MemberwiseParameter {
   Expr *DefaultExpr;
 
   MemberwiseParameter(Identifier name, Type type, Expr *initialExpr)
-    : Name(name), MemberType(type), DefaultExpr(initialExpr) {}
+      : Name(name), MemberType(type), DefaultExpr(initialExpr) {}
 };
 
 static void generateMemberwiseInit(SourceEditConsumer &EditConsumer,
@@ -3139,7 +3139,16 @@ static void generateMemberwiseInit(SourceEditConsumer &EditConsumer,
   EditConsumer.accept(SM, targetLocation, "\ninternal init(");
   auto insertMember = [&SM](const MemberwiseParameter &memberData,
                             llvm::raw_ostream &OS, bool wantsSeparator) {
-    OS << memberData.Name << ": " << memberData.MemberType.getString();
+    {
+      OS << memberData.Name << ": ";
+      // Unconditionally print '@escaping' if we print out a function type -
+      // the assignments we generate below will escape this parameter.
+      if (isa<AnyFunctionType>(memberData.MemberType->getCanonicalType())) {
+        OS << "@" << TypeAttributes::getAttrName(TAK_escaping) << " ";
+      }
+      OS << memberData.MemberType.getString();
+    }
+
     if (auto *expr = memberData.DefaultExpr) {
       if (isa<NilLiteralExpr>(expr)) {
         OS << " = nil";

test/refactoring/MemberwiseInit/Outputs/generate_memberwise/class_members.swift.expected

@@ -1,11 +1,13 @@
 class Person {
-internal init(firstName: String? = nil, lastName: String? = nil, age: Int? = nil, planet: String = "Earth", solarSystem: String = "Milky Way", avgHeight: Int = 175) {
+internal init(firstName: String? = nil, lastName: String? = nil, age: Int? = nil, planet: String = "Earth", solarSystem: String = "Milky Way", avgHeight: Int = 175, location: @escaping () -> Place = { fatalError() }, secondLocation: (() -> Place)? = nil) {
 self.firstName = firstName
 self.lastName = lastName
 self.age = age
 self.planet = planet
 self.solarSystem = solarSystem
 self.avgHeight = avgHeight
+self.location = location
+self.secondLocation = secondLocation
 }
 
   var firstName: String!
@@ -15,16 +17,20 @@ self.avgHeight = avgHeight
   var avgHeight = 175
   let line = #line, file = #file, handle = #dsohandle
   lazy var idea: Idea = { fatalError() }()
+  var location: () -> Place = { fatalError() }
+  var secondLocation: (() -> Place)!
 }
 
 struct Place {
+  typealias Callback = () -> ()
   let person: Person
   let street: String
   let apartment: Optional<String>
   let city: String
   let state: String
   let postalCode: Int
   let plusFour: Int?
+  let callback: Callback
 }
 
 protocol Thing {

test/refactoring/MemberwiseInit/Outputs/generate_memberwise/struct_members.swift.expected

@@ -6,26 +6,31 @@ class Person {
   var avgHeight = 175
   let line = #line, file = #file, handle = #dsohandle
   lazy var idea: Idea = { fatalError() }()
+  var location: () -> Place = { fatalError() }
+  var secondLocation: (() -> Place)!
 }
 
 struct Place {
-internal init(person: Person, street: String, apartment: Optional<String>, city: String, state: String, postalCode: Int, plusFour: Int?) {
+internal init(person: Person, street: String, apartment: Optional<String>, city: String, state: String, postalCode: Int, plusFour: Int?, callback: @escaping Place.Callback) {
 self.person = person
 self.street = street
 self.apartment = apartment
 self.city = city
 self.state = state
 self.postalCode = postalCode
 self.plusFour = plusFour
+self.callback = callback
 }
 
+  typealias Callback = () -> ()
   let person: Person
   let street: String
   let apartment: Optional<String>
   let city: String
   let state: String
   let postalCode: Int
   let plusFour: Int?
+  let callback: Callback
 }
 
 protocol Thing {

test/refactoring/MemberwiseInit/generate_memberwise.swift

@@ -6,16 +6,20 @@ class Person {
   var avgHeight = 175
   let line = #line, file = #file, handle = #dsohandle
   lazy var idea: Idea = { fatalError() }()
+  var location: () -> Place = { fatalError() }
+  var secondLocation: (() -> Place)!
 }
 
 struct Place {
+  typealias Callback = () -> ()
   let person: Person
   let street: String
   let apartment: Optional<String>
   let city: String
   let state: String
   let postalCode: Int
   let plusFour: Int?
+  let callback: Callback
 }
 
 protocol Thing {
@@ -30,7 +34,7 @@ enum Idea {
 // RUN: %refactor -memberwise-init -source-filename %s -pos=1:8 > %t.result/generate_memberwise.swift
 // RUN: diff -u %S/Outputs/generate_memberwise/class_members.swift.expected %t.result/generate_memberwise.swift
 
-// RUN: %refactor -memberwise-init -source-filename %s -pos=11:8 > %t.result/struct_members.swift
+// RUN: %refactor -memberwise-init -source-filename %s -pos=13:8 > %t.result/struct_members.swift
 // RUN: diff -u %S/Outputs/generate_memberwise/struct_members.swift.expected %t.result/struct_members.swift
 
 // RUN: not %refactor -memberwise-init -source-filename %s -pos=21:10 > %t.result/protocol_members.swift