Merge pull request #61028 from xedin/type-wrapper-ignore-attr

[AST/TypeChecker] TypeWrappers: Add @typeWrapperIgnored attribute

Author: xedin

include/swift/AST/Attr.def

@@ -777,6 +777,11 @@ DECL_ATTR(_documentation, Documentation,
   APIBreakingToAdd | APIStableToRemove | ABIStableToAdd | ABIStableToRemove,
   136)
 
+SIMPLE_DECL_ATTR(typeWrapperIgnored, TypeWrapperIgnored,
+  OnVar |
+  ABIStableToAdd | ABIStableToRemove | APIStableToAdd | APIStableToRemove,
+  137)
+
 // If you're adding a new underscored attribute here, please document it in
 // docs/ReferenceGuides/UnderscoredAttributes.md.
 

include/swift/AST/DiagnosticsSema.def

@@ -6568,5 +6568,14 @@ ERROR(type_wrapper_type_requirement_not_accessible,none,
       "(which is %select{private|fileprivate|internal|public|open}4)",
       (AccessLevel, DescriptiveDeclKind, DeclName, Type, AccessLevel))
 
+ERROR(type_wrapper_ignored_on_local_properties,none,
+      "%0 must not be used on local properties", (DeclAttribute))
+ERROR(type_wrapper_ignored_on_computed_properties,none,
+      "%0 must not be used on computed properties", (DeclAttribute))
+ERROR(type_wrapper_ignored_on_static_properties,none,
+      "%0 must not be used on static properties", (DeclAttribute))
+ERROR(type_wrapper_ignored_on_lazy_properties,none,
+      "%0 must not be used on lazy properties", (DeclAttribute))
+
 #define UNDEFINE_DIAGNOSTIC_MACROS
 #include "DefineDiagnosticMacros.h"

lib/Sema/CodeSynthesis.cpp

@@ -385,8 +385,12 @@ static ConstructorDecl *createImplicitConstructor(NominalTypeDecl *decl,
         if (var->isImplicit())
           continue;
 
-        // Computed properties are not included.
-        if (!var->hasStorage())
+        // Computed properties are not included, except in cases
+        // where property has a property wrapper and `@typeWrapperIgnored`
+        // attribute.
+        if (!var->hasStorage() &&
+            !(var->hasAttachedPropertyWrapper() &&
+              var->getAttrs().hasAttribute<TypeWrapperIgnoredAttr>()))
           continue;
 
         // If this is a memberwise initializeable property include

lib/Sema/TypeCheckAttr.cpp

@@ -294,6 +294,7 @@ class AttributeChecker : public AttributeVisitor<AttributeChecker> {
   void visitCustomAttr(CustomAttr *attr);
   void visitPropertyWrapperAttr(PropertyWrapperAttr *attr);
   void visitTypeWrapperAttr(TypeWrapperAttr *attr);
+  void visitTypeWrapperIgnoredAttr(TypeWrapperIgnoredAttr *attr);
   void visitResultBuilderAttr(ResultBuilderAttr *attr);
 
   void visitImplementationOnlyAttr(ImplementationOnlyAttr *attr);
@@ -3796,6 +3797,46 @@ void AttributeChecker::visitTypeWrapperAttr(TypeWrapperAttr *attr) {
   }
 }
 
+void AttributeChecker::visitTypeWrapperIgnoredAttr(TypeWrapperIgnoredAttr *attr) {
+  auto *var = cast<VarDecl>(D);
+
+  // @typeWrapperIgnored applies only to properties that type wrapper can manage.
+  if (var->getDeclContext()->isLocalContext()) {
+    diagnoseAndRemoveAttr(attr, diag::type_wrapper_ignored_on_local_properties, attr);
+    return;
+  }
+
+  if (var->isLet()) {
+    diagnoseAndRemoveAttr(attr, diag::attr_only_one_decl_kind, attr, "var");
+    return;
+  }
+
+  if (var->getAttrs().hasAttribute<LazyAttr>()) {
+    diagnoseAndRemoveAttr(attr, diag::type_wrapper_ignored_on_lazy_properties, attr);
+    return;
+  }
+
+  if (var->isStatic()) {
+    diagnoseAndRemoveAttr(attr, diag::type_wrapper_ignored_on_static_properties, attr);
+    return;
+  }
+
+  // computed properties
+  {
+    SmallVector<AccessorKind, 4> accessors{AccessorKind::Get, AccessorKind::Set,
+                                           AccessorKind::Modify,
+                                           AccessorKind::MutableAddress};
+
+    if (llvm::any_of(accessors, [&var](const auto &accessor) {
+          return var->getParsedAccessor(accessor);
+        })) {
+      diagnoseAndRemoveAttr(
+          attr, diag::type_wrapper_ignored_on_computed_properties, attr);
+      return;
+    }
+  }
+}
+
 void AttributeChecker::visitResultBuilderAttr(ResultBuilderAttr *attr) {
   auto *nominal = dyn_cast<NominalTypeDecl>(D);
   auto &ctx = D->getASTContext();

lib/Sema/TypeCheckDeclOverride.cpp

@@ -1587,6 +1587,7 @@ namespace  {
     UNINTERESTING_ATTR(Custom)
     UNINTERESTING_ATTR(PropertyWrapper)
     UNINTERESTING_ATTR(TypeWrapper)
+    UNINTERESTING_ATTR(TypeWrapperIgnored)
     UNINTERESTING_ATTR(DisfavoredOverload)
     UNINTERESTING_ATTR(ResultBuilder)
     UNINTERESTING_ATTR(ProjectedValueProperty)

lib/Sema/TypeCheckTypeWrapper.cpp

@@ -315,6 +315,11 @@ bool IsPropertyAccessedViaTypeWrapper::evaluate(Evaluator &evaluator,
   if (property->isStatic() || property->isLet())
     return false;
 
+  // If this property has `@typeWrapperIgnored` attribute
+  // it should not be managed by a type wrapper.
+  if (property->getAttrs().hasAttribute<TypeWrapperIgnoredAttr>())
+    return false;
+
   // `lazy` properties are not wrapped.
   if (property->getAttrs().hasAttribute<LazyAttr>() ||
       property->isLazyStorageProperty())
@@ -337,9 +342,13 @@ bool IsPropertyAccessedViaTypeWrapper::evaluate(Evaluator &evaluator,
     // This is the only thing that wrapper needs to handle because
     // all access to the wrapped variable and it's projection
     // is routed through it.
-    if (property->getOriginalWrappedProperty(
-          PropertyWrapperSynthesizedPropertyKind::Backing))
-      return true;
+    if (auto *wrappedProperty = property->getOriginalWrappedProperty(
+            PropertyWrapperSynthesizedPropertyKind::Backing)) {
+      // If wrapped property is ignored - its backing storage is
+      // ignored as well.
+      return !wrappedProperty->getAttrs()
+                  .hasAttribute<TypeWrapperIgnoredAttr>();
+    }
   }
 
   // Don't wrap any compiler synthesized properties except to

test/IDE/complete_decl_attribute.swift

@@ -172,6 +172,7 @@ actor MyGlobalActor {
 // ON_GLOBALVAR-DAG: Keyword/None:                       noDerivative[#Var Attribute#]; name=noDerivative
 // ON_GLOBALVAR-DAG: Keyword/None:                       exclusivity[#Var Attribute#]; name=exclusivity
 // ON_GLOBALVAR-DAG: Keyword/None:                       preconcurrency[#Var Attribute#]; name=preconcurrency
+// ON_GLOBALVAR-DAG: Keyword/None:                       typeWrapperIgnored[#Var Attribute#]; name=typeWrapperIgnored
 // ON_GLOBALVAR-NOT: Keyword
 // ON_GLOBALVAR-DAG: Decl[Struct]/CurrModule:            MyStruct[#MyStruct#]; name=MyStruct
 // ON_GLOBALVAR-DAG: Decl[Struct]/CurrModule/TypeRelation[Convertible]: MyPropertyWrapper[#MyPropertyWrapper#]; name=MyPropertyWrapper
@@ -209,6 +210,7 @@ struct _S {
 // ON_PROPERTY-DAG: Keyword/None:                       noDerivative[#Var Attribute#]; name=noDerivative
 // ON_PROPERTY-DAG: Keyword/None:                       exclusivity[#Var Attribute#]; name=exclusivity
 // ON_PROPERTY-DAG: Keyword/None:                       preconcurrency[#Var Attribute#]; name=preconcurrency
+// ON_PROPERTY-DAG: Keyword/None:                       typeWrapperIgnored[#Var Attribute#]; name=typeWrapperIgnored
 // ON_PROPERTY-NOT: Keyword
 // ON_PROPERTY-DAG: Decl[Struct]/CurrModule:            MyStruct[#MyStruct#]; name=MyStruct
 // ON_PROPERTY-DAG: Decl[Struct]/CurrModule/TypeRelation[Convertible]: MyPropertyWrapper[#MyPropertyWrapper#]; name=MyPropertyWrapper
@@ -309,6 +311,7 @@ struct _S {
 // ON_MEMBER_LAST-DAG: Keyword/None:                       exclusivity[#Declaration Attribute#]; name=exclusivity
 // ON_MEMBER_LAST-DAG: Keyword/None:                       preconcurrency[#Declaration Attribute#]; name=preconcurrency
 // ON_MEMBER_LAST-DAG: Keyword/None:                       typeWrapper[#Declaration Attribute#]; name=typeWrapper
+// ON_MEMBER_LAST-DAG: Keyword/None:                       typeWrapperIgnored[#Declaration Attribute#]; name=typeWrapperIgnored
 // ON_MEMBER_LAST-NOT: Keyword
 // ON_MEMBER_LAST-DAG: Decl[Struct]/CurrModule:            MyStruct[#MyStruct#]; name=MyStruct
 // ON_MEMBER_LAST-DAG: Decl[Struct]/CurrModule/TypeRelation[Convertible]: MyPropertyWrapper[#MyPropertyWrapper#]; name=MyPropertyWrapper
@@ -379,6 +382,7 @@ func dummy2() {}
 // KEYWORD_LAST-DAG: Keyword/None:                       exclusivity[#Declaration Attribute#]; name=exclusivity
 // KEYWORD_LAST-DAG: Keyword/None:                       preconcurrency[#Declaration Attribute#]; name=preconcurrency
 // KEYWORD_LAST-DAG: Keyword/None:                       typeWrapper[#Declaration Attribute#]; name=typeWrapper
+// KEYWORD_LAST-DAG: Keyword/None:                       typeWrapperIgnored[#Declaration Attribute#]; name=typeWrapperIgnored
 // KEYWORD_LAST-NOT: Keyword
 // KEYWORD_LAST-DAG: Decl[Struct]/CurrModule:            MyStruct[#MyStruct#]; name=MyStruct
 // KEYWORD_LAST-DAG: Decl[Struct]/CurrModule/TypeRelation[Convertible]: MyPropertyWrapper[#MyPropertyWrapper#]; name=MyPropertyWrapper

test/Interpreter/Inputs/type_wrapper_defs.swift

@@ -146,3 +146,10 @@ public class ClassWithDesignatedInit {
     $_storage = .init(memberwise: $Storage(a: 42, _b: PropWrapperWithoutInit(value: b)))
   }
 }
+
+@Wrapper
+public class PersonWithIgnoredAge {
+  public var name: String
+  @typeWrapperIgnored public var age: Int = 0
+  @typeWrapperIgnored @PropWrapper public var manufacturer: String?
+}

test/Interpreter/type_wrappers.swift

@@ -408,3 +408,44 @@ do {
   // CHECK: in getter
   // CHECK-NEXT: [42]
 }
+
+do {
+  var arthur = PersonWithIgnoredAge(name: "Arthur Dent", age: 30)
+  // CHECK: Wrapper.init($Storage(name: "Arthur Dent"))
+
+  print(arthur.name)
+  // CHECK: in getter
+  // CHECK-NEXT: Arthur Dent
+
+  print(arthur.age)
+  // CHECK-NOT: in getter
+  // CHECK-NEXT: 30
+
+  print(arthur.manufacturer)
+  // CHECK-NOT: in getter
+  // CHECK-NEXT: nil
+
+  arthur.age = 32
+  // CHECK-NOT: in setter
+
+  var marvin = PersonWithIgnoredAge(name: "Marvin The Paranoid Android", manufacturer: "Sirius Cybernetics Corporation")
+  // CHECK: Wrapper.init($Storage(name: "Marvin The Paranoid Android"))
+
+  print(marvin.name)
+  // CHECK: in getter
+  // CHECK-NEXT: Marvin The Paranoid Android
+
+  print(marvin.age)
+  // CHECK-NOT: in getter
+  // CHECK-NEXT: 0
+
+  print(marvin.manufacturer)
+  // CHECK-NOT: in getter
+  // CHECK-NEXT: Sirius Cybernetics Corporation
+
+  marvin.age = 1000
+  // CHECK-NOT: in setter
+
+  marvin.manufacturer = nil
+  // CHECK-NOT: in setter
+}

test/type/type_wrapper.swift

@@ -398,3 +398,42 @@ func testActors() async {
   person.name = "NoName" // expected-error {{actor-isolated property 'name' can not be mutated from a non-isolated context}}
   person.age = 0 // expected-error {{actor-isolated property 'age' can not be mutated from a non-isolated context}}
 }
+
+func testIgnoredAttr() {
+  @NoopWrapper
+  struct X {
+    @typeWrapperIgnored static var staticVar: Int = 0 // expected-error {{@typeWrapperIgnored must not be used on static properties}}
+
+    @typeWrapperIgnored lazy var lazyVar: Int = { // expected-error {{@typeWrapperIgnored must not be used on lazy properties}}
+      42
+    }()
+
+    @typeWrapperIgnored var x: Int // Ok
+
+    var y: Int {
+      @typeWrapperIgnored get { // expected-error {{@typeWrapperIgnored may only be used on 'var' declarations}}
+        42
+      }
+
+      @typeWrapperIgnored set { // expected-error {{@typeWrapperIgnored may only be used on 'var' declarations}}
+      }
+    }
+
+    @typeWrapperIgnored var computed: Int { // expected-error {{@typeWrapperIgnored must not be used on computed properties}}
+      get { 42 }
+      set {}
+    }
+
+    @typeWrapperIgnored let z: Int = 0 // expected-error {{@typeWrapperIgnored may only be used on 'var' declarations}}
+
+    func test_param(@typeWrapperIgnored x: Int) {} // expected-error {{@typeWrapperIgnored may only be used on 'var' declarations}}
+
+    func test_local() {
+      @typeWrapperIgnored var x: Int = 42 // expected-error {{@typeWrapperIgnored must not be used on local properties}}
+      // expected-warning@-1 {{variable 'x' was never used; consider replacing with '_' or removing it}}
+
+      @typeWrapperIgnored let y: String // expected-error {{@typeWrapperIgnored must not be used on local properties}}
+      // expected-warning@-1 {{immutable value 'y' was never used; consider replacing with '_' or removing it}}
+    }
+  }
+}