Create stub stored properties in main objcImpl

beccadax · beccadax · commit e9886f430ac2 · 2025-04-02T18:35:24.000-07:00
Further modify objcImpl missing requirement diagnostics so the stubs create stored properties in the main body, or computed properties otherwise. Also tweak printing so we use `let` where appropriate.
diff --git a/include/swift/AST/PrintOptions.h b/include/swift/AST/PrintOptions.h
@@ -143,6 +143,9 @@ struct PrintOptions {
   /// Whether to print *any* accessors on properties.
   bool PrintPropertyAccessors = true;
 
+  /// Use \c let for a read-only computed property.
+  bool InferPropertyIntroducerFromAccessors = false;
+
   /// Whether to print *any* accessors on subscript.
   bool PrintSubscriptAccessors = true;
 
diff --git a/lib/AST/ASTPrinter.cpp b/lib/AST/ASTPrinter.cpp
@@ -3939,11 +3939,18 @@ void PrintAST::visitVarDecl(VarDecl *decl) {
   if (decl->isStatic() && Options.PrintStaticKeyword)
     printStaticKeyword(decl->getCorrectStaticSpelling());
   if (decl->getKind() == DeclKind::Var || Options.PrintParameterSpecifiers) {
+    // If InferPropertyIntroducerFromAccessors is set, turn all read-only
+    // properties to `let`.
+    auto introducer = decl->getIntroducer();
+    if (Options.InferPropertyIntroducerFromAccessors &&
+          !cast<VarDecl>(decl)->isSettable(nullptr))
+      introducer = VarDecl::Introducer::Let;
+
     // Map all non-let specifiers to 'var'.  This is not correct, but
     // SourceKit relies on this for info about parameter decls.
     
     Printer.printIntroducerKeyword(
-      decl->getIntroducer() == VarDecl::Introducer::Let ? "let" : "var",
+      introducer == VarDecl::Introducer::Let ? "let" : "var",
       Options, " ");
   }
   printContextIfNeeded(decl);
diff --git a/lib/Sema/TypeCheckProtocol.cpp b/lib/Sema/TypeCheckProtocol.cpp
@@ -3696,7 +3696,10 @@ bool swift::
 printRequirementStub(ValueDecl *Requirement, DeclContext *Adopter,
                      Type AdopterTy, SourceLoc TypeLoc, raw_ostream &OS,
                      bool withExplicitObjCAttr) {
-  if (isa<ConstructorDecl>(Requirement)) {
+  // We sometimes use this for @implementation extensions too.
+  bool forProtocol = isa<ProtocolDecl>(Requirement->getDeclContext());
+
+  if (isa<ConstructorDecl>(Requirement) && forProtocol) {
     if (auto CD = Adopter->getSelfClassDecl()) {
       if (!CD->isSemanticallyFinal() && isa<ExtensionDecl>(Adopter)) {
         // In this case, user should mark class as 'final' or define
@@ -3764,7 +3767,7 @@ printRequirementStub(ValueDecl *Requirement, DeclContext *Adopter,
 
     Printer << "\n";
   } else {
-    if (isa<ConstructorDecl>(Requirement)) {
+    if (isa<ConstructorDecl>(Requirement) && forProtocol) {
       if (auto CD = Adopter->getSelfClassDecl()) {
         if (!CD->isFinal()) {
           Printer << "required ";
@@ -3799,9 +3802,9 @@ printRequirementStub(ValueDecl *Requirement, DeclContext *Adopter,
     };
     Options.setBaseType(AdopterTy);
     Options.CurrentModule = Adopter->getParentModule();
-    if (isa<NominalTypeDecl>(Adopter)) {
+    if (isa<NominalTypeDecl>(Adopter->getImplementedObjCContext())) {
       // Create a variable declaration instead of a computed property in
-      // nominal types...
+      // nominal types (or implementations thereof)...
       Options.PrintPropertyAccessors = false;
 
       // ...but a non-mutating setter requirement will force us into a
@@ -3812,6 +3815,11 @@ printRequirementStub(ValueDecl *Requirement, DeclContext *Adopter,
           if (const auto Set = VD->getOpaqueAccessor(AccessorKind::Set))
             if (Set->getAttrs().hasAttribute<NonMutatingAttr>())
               Options.PrintPropertyAccessors = true;
+
+      // If we're not printing the accessors, make them affect the introducer
+      // instead.
+      Options.InferPropertyIntroducerFromAccessors =
+          !Options.PrintPropertyAccessors;
     }
     Requirement->print(Printer, Options);
     Printer << "\n";
diff --git a/test/decl/ext/Inputs/objc_implementation.h b/test/decl/ext/Inputs/objc_implementation.h
@@ -85,6 +85,10 @@
 @property int categoryPropertyFromHeader2;
 @property int categoryPropertyFromHeader3;
 @property int categoryPropertyFromHeader4;
+@property int categoryPropertyFromHeader5;
+
+@property (readonly) int categoryReadonlyPropertyFromHeader1;
+
 
 @end
 
diff --git a/test/decl/ext/objc_implementation.swift b/test/decl/ext/objc_implementation.swift
@@ -17,7 +17,7 @@ protocol EmptySwiftProto {}
   // FIXME: give better diagnostic expected-note@-8 {{missing instance method 'method(fromHeader3:)'}} {{none}}
   // expected-note@-9 {{missing instance method 'extensionMethod(fromHeader2:)'}} {{none}}
   // expected-note@-10 {{missing property 'readonlyPropertyFromHeader7'}}
-  // expected-note@-11 {{add stubs for missing '@implementation' requirements}} {{77-77=\n    @objc(methodFromHeader3:)\n    open func method(fromHeader3 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(methodFromHeader4:)\n    open func method(fromHeader4 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(propertyFromHeader7)\n    open var propertyFromHeader7: Int32 {\n        get {\n            <#code#>\n        \}\n        set {\n            <#code#>\n        \}\n    \}\n\n    @objc(propertyFromHeader8)\n    open var propertyFromHeader8: Int32 {\n        get {\n            <#code#>\n        \}\n        set {\n            <#code#>\n        \}\n    \}\n\n    @objc(propertyFromHeader9)\n    open var propertyFromHeader9: Int32 {\n        get {\n            <#code#>\n        \}\n        set {\n            <#code#>\n        \}\n    \}\n\n    @objc(readonlyPropertyFromHeader7)\n    open var readonlyPropertyFromHeader7: Int32 {\n        <#code#>\n    \}\n\n    @objc(extensionMethodFromHeader2:)\n    open func extensionMethod(fromHeader2 param: Int32) {\n        <#code#>\n    \}\n}}
+  // expected-note@-11 {{add stubs for missing '@implementation' requirements}} {{77-77=\n    @objc(methodFromHeader3:)\n    open func method(fromHeader3 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(methodFromHeader4:)\n    open func method(fromHeader4 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(propertyFromHeader7)\n    open var propertyFromHeader7: Int32\n\n    @objc(propertyFromHeader8)\n    open var propertyFromHeader8: Int32\n\n    @objc(propertyFromHeader9)\n    open var propertyFromHeader9: Int32\n\n    @objc(readonlyPropertyFromHeader7)\n    open let readonlyPropertyFromHeader7: Int32\n\n    @objc(extensionMethodFromHeader2:)\n    open func extensionMethod(fromHeader2 param: Int32) {\n        <#code#>\n    \}\n}}
 
   func method(fromHeader1: CInt) {
     // OK, provides an implementation for the header's method.
@@ -241,7 +241,9 @@ protocol EmptySwiftProto {}
   // expected-error@-1 {{extension for category 'PresentAdditions' does not provide all required implementations}}
   // expected-note@-2 {{missing instance method 'categoryMethod(fromHeader4:)'}} {{none}}
   // FIXME: give better diagnostic expected-note@-3 {{missing instance method 'categoryMethod(fromHeader3:)'}} {{none}}
-  // expected-note@-4 {{add stubs for missing '@implementation' requirements}} {{62-62=\n    @objc(categoryMethodFromHeader3:)\n    open func categoryMethod(fromHeader3 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(categoryMethodFromHeader4:)\n    open func categoryMethod(fromHeader4 param: Int32) {\n        <#code#>\n    \}\n}}
+  // expected-note@-4 {{missing property 'categoryPropertyFromHeader5'}} {{none}}
+  // expected-note@-5 {{missing property 'categoryReadonlyPropertyFromHeader1'}} {{none}}
+  // expected-note@-6 {{add stubs for missing '@implementation' requirements}} {{62-62=\n    @objc(categoryMethodFromHeader3:)\n    open func categoryMethod(fromHeader3 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(categoryMethodFromHeader4:)\n    open func categoryMethod(fromHeader4 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(categoryPropertyFromHeader5)\n    open var categoryPropertyFromHeader5: Int32 {\n        get {\n            <#code#>\n        \}\n        set {\n            <#code#>\n        \}\n    \}\n\n    @objc(categoryReadonlyPropertyFromHeader1)\n    open var categoryReadonlyPropertyFromHeader1: Int32 {\n        <#code#>\n    \}\n}}
 
   func method(fromHeader3: CInt) {
     // FIXME: should emit expected-DISABLED-error@-1 {{instance method 'method(fromHeader3:)' should be implemented in extension for main class interface, not category 'PresentAdditions'}}
diff --git a/test/decl/ext/objc_implementation_class_extension.swift b/test/decl/ext/objc_implementation_class_extension.swift
@@ -11,7 +11,7 @@
   // expected-note@-5 {{missing property 'otherModuleExtensionPropertyFromHeader2'}} {{none}}
   // expected-note@-6 {{missing instance method 'extensionMethod(fromHeader2:)'}} {{none}}
   // expected-note@-7 {{missing property 'extensionPropertyFromHeader2'}} {{none}}
-  // expected-note@-8 {{add stubs for missing '@implementation' requirements}} {{43-43=\n    @objc(methodFromHeader2:)\n    open func method(fromHeader2 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(propertyFromHeader2)\n    open var propertyFromHeader2: Int32 {\n        get {\n            <#code#>\n        \}\n        set {\n            <#code#>\n        \}\n    \}\n\n    @objc(otherModuleExtensionMethodFromHeader2:)\n    open func otherModuleExtensionMethod(fromHeader2 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(otherModuleExtensionPropertyFromHeader2)\n    open var otherModuleExtensionPropertyFromHeader2: Int32 {\n        get {\n            <#code#>\n        \}\n        set {\n            <#code#>\n        \}\n    \}\n\n    @objc(extensionMethodFromHeader2:)\n    open func extensionMethod(fromHeader2 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(extensionPropertyFromHeader2)\n    open var extensionPropertyFromHeader2: Int32 {\n        get {\n            <#code#>\n        \}\n        set {\n            <#code#>\n        \}\n    \}\n}}
+  // expected-note@-8 {{add stubs for missing '@implementation' requirements}} {{43-43=\n    @objc(methodFromHeader2:)\n    open func method(fromHeader2 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(propertyFromHeader2)\n    open var propertyFromHeader2: Int32\n\n    @objc(otherModuleExtensionMethodFromHeader2:)\n    open func otherModuleExtensionMethod(fromHeader2 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(otherModuleExtensionPropertyFromHeader2)\n    open var otherModuleExtensionPropertyFromHeader2: Int32\n\n    @objc(extensionMethodFromHeader2:)\n    open func extensionMethod(fromHeader2 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(extensionPropertyFromHeader2)\n    open var extensionPropertyFromHeader2: Int32\n}}
 
   @objc func method(fromHeader1: CInt) {}
   @objc private func method(fromHeader2: CInt) {}
diff --git a/test/decl/ext/objc_implementation_early_adopter.swift b/test/decl/ext/objc_implementation_early_adopter.swift
@@ -17,7 +17,7 @@ protocol EmptySwiftProto {}
   // FIXME: give better diagnostic expected-note@-8 {{missing instance method 'method(fromHeader3:)'}} {{none}}
   // expected-note@-9 {{missing instance method 'extensionMethod(fromHeader2:)'}} {{none}}
   // expected-note@-10 {{missing property 'readonlyPropertyFromHeader7'}}
-  // expected-note@-11 {{add stubs for missing '@implementation' requirements}} {{76-76=\n    @objc(methodFromHeader3:)\n    open func method(fromHeader3 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(methodFromHeader4:)\n    open func method(fromHeader4 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(propertyFromHeader7)\n    open var propertyFromHeader7: Int32 {\n        get {\n            <#code#>\n        \}\n        set {\n            <#code#>\n        \}\n    \}\n\n    @objc(propertyFromHeader8)\n    open var propertyFromHeader8: Int32 {\n        get {\n            <#code#>\n        \}\n        set {\n            <#code#>\n        \}\n    \}\n\n    @objc(propertyFromHeader9)\n    open var propertyFromHeader9: Int32 {\n        get {\n            <#code#>\n        \}\n        set {\n            <#code#>\n        \}\n    \}\n\n    @objc(readonlyPropertyFromHeader7)\n    open var readonlyPropertyFromHeader7: Int32 {\n        <#code#>\n    \}\n\n    @objc(extensionMethodFromHeader2:)\n    open func extensionMethod(fromHeader2 param: Int32) {\n        <#code#>\n    \}\n}}
+  // expected-note@-11 {{add stubs for missing '@implementation' requirements}} {{76-76=\n    @objc(methodFromHeader3:)\n    open func method(fromHeader3 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(methodFromHeader4:)\n    open func method(fromHeader4 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(propertyFromHeader7)\n    open var propertyFromHeader7: Int32\n\n    @objc(propertyFromHeader8)\n    open var propertyFromHeader8: Int32\n\n    @objc(propertyFromHeader9)\n    open var propertyFromHeader9: Int32\n\n    @objc(readonlyPropertyFromHeader7)\n    open let readonlyPropertyFromHeader7: Int32\n\n    @objc(extensionMethodFromHeader2:)\n    open func extensionMethod(fromHeader2 param: Int32) {\n        <#code#>\n    \}\n}}
 
   func method(fromHeader1: CInt) {
     // OK, provides an implementation for the header's method.
@@ -241,7 +241,9 @@ protocol EmptySwiftProto {}
   // expected-warning@-1 {{extension for category 'PresentAdditions' does not provide all required implementations; this will become an error after adopting '@implementation'}}
   // expected-note@-2 {{missing instance method 'categoryMethod(fromHeader4:)'}} {{none}}
   // FIXME: give better diagnostic expected-note@-3 {{missing instance method 'categoryMethod(fromHeader3:)'}} {{none}}
-  // expected-note@-4 {{add stubs for missing '@implementation' requirements}} {{61-61=\n    @objc(categoryMethodFromHeader3:)\n    open func categoryMethod(fromHeader3 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(categoryMethodFromHeader4:)\n    open func categoryMethod(fromHeader4 param: Int32) {\n        <#code#>\n    \}\n}}
+  // expected-note@-4 {{missing property 'categoryPropertyFromHeader5'}} {{none}}
+  // expected-note@-5 {{missing property 'categoryReadonlyPropertyFromHeader1'}} {{none}}
+  // expected-note@-6 {{add stubs for missing '@implementation' requirements}} {{61-61=\n    @objc(categoryMethodFromHeader3:)\n    open func categoryMethod(fromHeader3 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(categoryMethodFromHeader4:)\n    open func categoryMethod(fromHeader4 param: Int32) {\n        <#code#>\n    \}\n\n    @objc(categoryPropertyFromHeader5)\n    open var categoryPropertyFromHeader5: Int32 {\n        get {\n            <#code#>\n        \}\n        set {\n            <#code#>\n        \}\n    \}\n\n    @objc(categoryReadonlyPropertyFromHeader1)\n    open var categoryReadonlyPropertyFromHeader1: Int32 {\n        <#code#>\n    \}\n}}
 
   func method(fromHeader3: CInt) {
     // FIXME: should emit expected-DISABLED-error@-1 {{instance method 'method(fromHeader3:)' should be implemented in extension for main class interface, not category 'PresentAdditions'}}
