Merge pull request #25458 from DougGregor/property-wrapper-wrapped-value-rename

Author: swift-ci

include/swift/AST/DiagnosticsSema.def

@@ -4387,7 +4387,8 @@ ERROR(property_wrapper_ambiguous_value_property, none,
   "named %1", (Type, Identifier))
 ERROR(property_wrapper_wrong_initial_value_init, none,
       "'init(initialValue:)' parameter type (%0) must be the same as its "
-      "'value' property type (%1) or an @autoclosure thereof", (Type, Type))
+      "'wrappedValue' property type (%1) or an @autoclosure thereof",
+      (Type, Type))
 ERROR(property_wrapper_failable_init, none,
       "%0 cannot be failable", (DeclName))
 ERROR(property_wrapper_ambiguous_initial_value_init, none,
@@ -4440,7 +4441,7 @@ NOTE(property_wrapper_direct_init,none,
      "'(...') on the attribute", ())
 
 ERROR(property_wrapper_incompatible_property, none,
-      "property type %0 does not match that of the 'value' property of "
+      "property type %0 does not match that of the 'wrappedValue' property of "
       "its wrapper type %1", (Type, Type))
 
 ERROR(property_wrapper_type_access,none,
@@ -4460,6 +4461,9 @@ ERROR(property_wrapper_type_not_usable_from_inline,none,
 WARNING(property_wrapper_delegateValue,none,
         "property wrapper's `delegateValue` property should be renamed to "
         "'wrapperValue'; use of 'delegateValue' is deprecated", ())
+WARNING(property_wrapper_value,none,
+        "property wrapper's `value` property should be renamed to "
+        "'wrappedValue'; use of 'value' is deprecated", ())
 
 //------------------------------------------------------------------------------
 // MARK: function builder diagnostics

include/swift/AST/KnownIdentifiers.def

@@ -121,6 +121,7 @@ IDENTIFIER(WinSDK)
 IDENTIFIER(with)
 IDENTIFIER(withArguments)
 IDENTIFIER(withKeywordArguments)
+IDENTIFIER(wrappedValue)
 IDENTIFIER(wrapperValue)
 
 // Kinds of layout constraints

lib/Sema/TypeCheckPropertyWrapper.cpp

@@ -28,7 +28,8 @@ using namespace swift;
 /// Find the named property in a property wrapper to which access will
 /// be delegated.
 static VarDecl *findValueProperty(ASTContext &ctx, NominalTypeDecl *nominal,
-                                  Identifier name, bool allowMissing) {
+                                  Identifier name, bool allowMissing,
+                                  bool *diagnosed = nullptr) {
   SmallVector<VarDecl *, 2> vars;
   {
     SmallVector<ValueDecl *, 2> decls;
@@ -49,6 +50,8 @@ static VarDecl *findValueProperty(ASTContext &ctx, NominalTypeDecl *nominal,
     if (!allowMissing) {
       nominal->diagnose(diag::property_wrapper_no_value_property,
                         nominal->getDeclaredType(), name);
+      if (diagnosed)
+        *diagnosed = true;
     }
     return nullptr;
 
@@ -62,6 +65,8 @@ static VarDecl *findValueProperty(ASTContext &ctx, NominalTypeDecl *nominal,
       var->diagnose(diag::kind_declname_declared_here,
                     var->getDescriptiveKind(), var->getFullName());
     }
+    if (diagnosed)
+      *diagnosed = true;
     return nullptr;
   }
 
@@ -72,6 +77,8 @@ static VarDecl *findValueProperty(ASTContext &ctx, NominalTypeDecl *nominal,
                   var->getFormalAccess(), var->getDescriptiveKind(),
                   var->getFullName(), nominal->getDeclaredType(),
                   nominal->getFormalAccess());
+    if (diagnosed)
+      *diagnosed = true;
     return nullptr;
   }
 
@@ -230,13 +237,32 @@ PropertyWrapperTypeInfoRequest::evaluate(
     return PropertyWrapperTypeInfo();
   }
 
-  // Look for a non-static property named "value" in the property wrapper
-  // type.
+  // Look for a non-static property named "wrappedValue" in the property
+  // wrapper type.
   ASTContext &ctx = nominal->getASTContext();
+  bool diagnosed = false;
   auto valueVar =
-      findValueProperty(ctx, nominal, ctx.Id_value, /*allowMissing=*/false);
-  if (!valueVar)
-    return PropertyWrapperTypeInfo();
+      findValueProperty(ctx, nominal, ctx.Id_wrappedValue,
+                        /*allowMissing=*/true, &diagnosed);
+  if (!valueVar) {
+    if (!diagnosed) {
+      // Look for a non-static property named "value". This is the old name,
+      // but accept it with a warning.
+      valueVar = findValueProperty(ctx, nominal, ctx.Id_value,
+                                   /*allowMissing=*/true, &diagnosed);
+    }
+
+    if (!valueVar) {
+      if (!diagnosed) {
+        valueVar = findValueProperty(ctx, nominal, ctx.Id_wrappedValue,
+                                     /*allowMissing=*/false);
+      }
+
+      return PropertyWrapperTypeInfo();
+    }
+
+    valueVar->diagnose(diag::property_wrapper_value);
+  }
 
   PropertyWrapperTypeInfo result;
   result.valueVar = valueVar;

test/SILOptimizer/di_property_wrappers_errors.swift

@@ -1,19 +1,19 @@
 // RUN: %target-swift-frontend -emit-sil -verify %s
 @propertyWrapper
 final class ClassWrapper<T> {
-  var value: T {
+  var wrappedValue: T {
     didSet {
-      print("  .. set \(value)")
+      print("  .. set \(wrappedValue)")
     }
   }
 
   init(initialValue: T) {
     print("  .. init \(initialValue)")
-    self.value = initialValue
+    self.wrappedValue = initialValue
   }
 
   deinit {
-    print("  .. deinit \(value)")
+    print("  .. deinit \(wrappedValue)")
   }
 }
 

test/decl/protocol/special/coding/property_wrappers_codable.swift

@@ -2,15 +2,15 @@
 
 @propertyWrapper
 struct Wrapper<T: Codable> {
-  var value: T
+  var wrappedValue: T
 }
 
 @propertyWrapper
 struct WrapperWithInitialValue<T: Codable> {
-  var value: T
+  var wrappedValue: T
 
   init(initialValue: T) {
-    self.value = initialValue
+    self.wrappedValue = initialValue
   }
 }
 

test/decl/var/property_wrapper_aliases.swift

@@ -4,10 +4,10 @@
 
 @propertyDelegate // expected-warning{{'@propertyDelegate' has been renamed to '@propertyWrapper'}}{{2-18=propertyWrapper}}
 struct Delegate<T> {
-  var value: T
+  var wrappedValue: T
 
   var delegateValue: Wrapper<T> { // expected-warning{{property wrapper's `delegateValue` property should be renamed to 'wrapperValue'; use of 'delegateValue' is deprecated}}{{7-20=wrapperValue}}
-    return Wrapper(value: value)
+    return Wrapper(wrappedValue: wrappedValue)
   }
 }
 
@@ -21,5 +21,18 @@ struct TestDelegateValue {
 
 @_propertyWrapper // expected-warning{{'@_propertyWrapper' has been renamed to '@propertyWrapper'}}{{2-18=propertyWrapper}}
 struct Wrapper<T> {
-  var value: T
+  var wrappedValue: T
+}
+
+@propertyWrapper
+struct OldValue<T> {
+  var value: T // expected-warning{{property wrapper's `value` property should be renamed to 'wrappedValue'; use of 'value' is deprecated}}
+}
+
+struct TestOldValue {
+  @OldValue var x: String
+
+  func f() -> String {
+    return x
+  }
 }