Skip to content

Don't inherit convenience inits if a designated init is missing. #8708

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 16 additions & 3 deletions include/swift/AST/Decl.h
Original file line number Diff line number Diff line change
Expand Up @@ -3186,9 +3186,6 @@ class ClassDecl : public NominalTypeDecl {
SourceLoc ClassLoc;
ObjCMethodLookupTable *ObjCMethodLookup = nullptr;

/// Whether the class has @objc ancestry.
unsigned ObjCKind : 3;

/// Create the Objective-C member lookup table.
void createObjCMethodLookup();

Expand All @@ -3198,6 +3195,11 @@ class ClassDecl : public NominalTypeDecl {
llvm::PointerIntPair<Type, 1, bool> Superclass;
} LazySemanticInfo;

/// Whether the class has @objc ancestry.
unsigned ObjCKind : 3;

unsigned HasMissingDesignatedInitializers : 1;

friend class IterativeTypeChecker;

public:
Expand Down Expand Up @@ -3282,6 +3284,17 @@ class ClassDecl : public NominalTypeDecl {
return getForeignClassKind() != ForeignKind::Normal;
}

/// Returns true if the class has designated initializers that are not listed
/// in its members.
///
/// This can occur, for example, if the class is an Objective-C class with
/// initializers that cannot be represented in Swift.
bool hasMissingDesignatedInitializers() const;

void setHasMissingDesignatedInitializers(bool newValue = true) {
HasMissingDesignatedInitializers = newValue;
}

/// Find a method of a class that overrides a given method.
/// Return nullptr, if no such method exists.
AbstractFunctionDecl *findOverridingDecl(
Expand Down
16 changes: 16 additions & 0 deletions lib/AST/Decl.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2443,6 +2443,7 @@ ClassDecl::ClassDecl(SourceLoc ClassLoc, Identifier Name, SourceLoc NameLoc,
ClassDeclBits.RawForeignKind = 0;
ClassDeclBits.HasDestructorDecl = 0;
ObjCKind = 0;
HasMissingDesignatedInitializers = 0;
}

DestructorDecl *ClassDecl::getDestructor() {
Expand All @@ -2453,6 +2454,13 @@ DestructorDecl *ClassDecl::getDestructor() {
return cast<DestructorDecl>(results.front());
}

bool ClassDecl::hasMissingDesignatedInitializers() const {
auto *mutableThis = const_cast<ClassDecl *>(this);
(void)mutableThis->lookupDirect(getASTContext().Id_init,
/*ignoreNewExtensions*/true);
return HasMissingDesignatedInitializers;
}

bool ClassDecl::inheritsSuperclassInitializers(LazyResolver *resolver) {
// Get a resolver from the ASTContext if we don't have one already.
if (resolver == nullptr)
Expand Down Expand Up @@ -2481,6 +2489,14 @@ bool ClassDecl::inheritsSuperclassInitializers(LazyResolver *resolver) {
return false;
}

// If the superclass has known-missing designated initializers, inheriting
// is unsafe.
if (superclassDecl->hasMissingDesignatedInitializers()) {
ClassDeclBits.InheritsSuperclassInits
= static_cast<unsigned>(StoredInheritsSuperclassInits::NotInherited);
return false;
}

// Look at all of the initializers of the subclass to gather the initializers
// they override from the superclass.
auto &ctx = getASTContext();
Expand Down
18 changes: 17 additions & 1 deletion lib/ClangImporter/ImportDecl.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6908,7 +6908,8 @@ ClangImporter::Implementation::importDeclImpl(const clang::NamedDecl *ClangDecl,
}
if (!Result && version == CurrentVersion) {
// If we couldn't import this Objective-C entity, determine
// whether it was a required member of a protocol.
// whether it was a required member of a protocol, or a designated
// initializer of a class.
bool hasMissingRequiredMember = false;
if (auto clangProto
= dyn_cast<clang::ObjCProtocolDecl>(ClangDecl->getDeclContext())) {
Expand All @@ -6930,6 +6931,21 @@ ClangImporter::Implementation::importDeclImpl(const clang::NamedDecl *ClangDecl,
}
}
}
if (auto method = dyn_cast<clang::ObjCMethodDecl>(ClangDecl)) {
if (!SwiftContext.LangOpts.isSwiftVersion3() &&
method->isDesignatedInitializerForTheInterface()) {
const clang::ObjCInterfaceDecl *theClass = method->getClassInterface();
assert(theClass && "cannot be a protocol method here");
// Only allow this to affect declarations in the same top-level module
// as the original class.
if (getClangModuleForDecl(theClass) == getClangModuleForDecl(method)) {
if (auto swiftClass = cast_or_null<ClassDecl>(
importDecl(theClass, CurrentVersion))) {
swiftClass->setHasMissingDesignatedInitializers();
}
}
}
}

return nullptr;
}
Expand Down
34 changes: 34 additions & 0 deletions test/ClangImporter/Inputs/custom-modules/UnimportableMembers.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
__attribute__((objc_root_class))
@interface Base
- (instancetype)init;
@end

@interface IncompleteDesignatedInitializers : Base
- (instancetype)initFirst:(long)x __attribute__((objc_designated_initializer));
- (instancetype)initSecond:(long)x __attribute__((objc_designated_initializer));
- (instancetype)initMissing:(long)x, ... __attribute__((objc_designated_initializer));
- (instancetype)initConveniently:(long)x;
@end
@interface IncompleteDesignatedInitializers (CategoryConvenience)
- (instancetype)initCategory:(long)x;
@end

@interface IncompleteConvenienceInitializers : Base
- (instancetype)initFirst:(long)x __attribute__((objc_designated_initializer));
- (instancetype)initSecond:(long)x __attribute__((objc_designated_initializer));
- (instancetype)initMissing:(long)x, ...;
- (instancetype)initConveniently:(long)x;
@end
@interface IncompleteConvenienceInitializers (CategoryConvenience)
- (instancetype)initCategory:(long)x;
@end

@interface IncompleteUnknownInitializers : Base
- (instancetype)initFirst:(long)x;
- (instancetype)initSecond:(long)x;
- (instancetype)initMissing:(long)x, ...;
- (instancetype)initConveniently:(long)x;
@end
@interface IncompleteUnknownInitializers (CategoryConvenience)
- (instancetype)initCategory:(long)x;
@end
4 changes: 4 additions & 0 deletions test/ClangImporter/Inputs/custom-modules/module.map
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,10 @@ module TypeAndValue {
export *
}

module UnimportableMembers {
header "UnimportableMembers.h"
}

module UsesSubmodule {
header "UsesSubmodule.h"
export *
Expand Down
68 changes: 68 additions & 0 deletions test/ClangImporter/objc_missing_designated_init.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
// RUN: %target-swift-frontend(mock-sdk: %clang-importer-sdk) -typecheck -I %S/Inputs/custom-modules %s -swift-version 4 -verify

// REQUIRES: objc_interop

import UnimportableMembers

class IncompleteInitSubclassImplicit : IncompleteDesignatedInitializers {
var myOneNewMember = 1
}

class IncompleteInitSubclass : IncompleteDesignatedInitializers {
override init(first: Int) {}
override init(second: Int) {}
}

class IncompleteConvenienceInitSubclass : IncompleteConvenienceInitializers {}

class IncompleteUnknownInitSubclass : IncompleteUnknownInitializers {}

func testBaseClassesBehaveAsExpected() {
_ = IncompleteDesignatedInitializers(first: 0) // okay
_ = IncompleteDesignatedInitializers(second: 0) // okay
_ = IncompleteDesignatedInitializers(missing: 0) // expected-error {{argument labels '(missing:)' do not match any available overloads}} expected-note {{overloads}}
_ = IncompleteDesignatedInitializers(conveniently: 0) // okay
_ = IncompleteDesignatedInitializers(category: 0) // okay

_ = IncompleteConvenienceInitializers(first: 0) // okay
_ = IncompleteConvenienceInitializers(second: 0) // okay
_ = IncompleteConvenienceInitializers(missing: 0) // expected-error {{argument labels '(missing:)' do not match any available overloads}} expected-note {{overloads}}
_ = IncompleteConvenienceInitializers(conveniently: 0) // okay
_ = IncompleteConvenienceInitializers(category: 0) // okay

_ = IncompleteUnknownInitializers(first: 0) // okay
_ = IncompleteUnknownInitializers(second: 0) // okay
_ = IncompleteUnknownInitializers(missing: 0) // expected-error {{argument labels '(missing:)' do not match any available overloads}} expected-note {{overloads}}
_ = IncompleteUnknownInitializers(conveniently: 0) // okay
_ = IncompleteUnknownInitializers(category: 0) // okay
}

func testSubclasses() {
_ = IncompleteInitSubclass(first: 0) // okay
_ = IncompleteInitSubclass(second: 0) // okay
_ = IncompleteInitSubclass(missing: 0) // expected-error {{argument labels '(missing:)' do not match any available overloads}} expected-note {{overloads}}
_ = IncompleteInitSubclass(conveniently: 0) // expected-error {{argument labels '(conveniently:)' do not match any available overloads}} expected-note {{overloads}}
_ = IncompleteInitSubclass(category: 0) // expected-error {{argument labels '(category:)' do not match any available overloads}} expected-note {{overloads}}

_ = IncompleteInitSubclassImplicit(first: 0) // okay
_ = IncompleteInitSubclassImplicit(second: 0) // okay
_ = IncompleteInitSubclassImplicit(missing: 0) // expected-error {{argument labels '(missing:)' do not match any available overloads}} expected-note {{overloads}}
_ = IncompleteInitSubclassImplicit(conveniently: 0) // expected-error {{argument labels '(conveniently:)' do not match any available overloads}} expected-note {{overloads}}
_ = IncompleteInitSubclassImplicit(category: 0) // expected-error {{argument labels '(category:)' do not match any available overloads}} expected-note {{overloads}}

_ = IncompleteConvenienceInitSubclass(first: 0) // okay
_ = IncompleteConvenienceInitSubclass(second: 0) // okay
_ = IncompleteConvenienceInitSubclass(missing: 0) // expected-error {{argument labels '(missing:)' do not match any available overloads}} expected-note {{overloads}}
_ = IncompleteConvenienceInitSubclass(conveniently: 0) // okay
_ = IncompleteConvenienceInitSubclass(category: 0) // okay

_ = IncompleteUnknownInitSubclass(first: 0) // okay
_ = IncompleteUnknownInitSubclass(second: 0) // okay
_ = IncompleteUnknownInitSubclass(missing: 0) // expected-error {{argument labels '(missing:)' do not match any available overloads}} expected-note {{overloads}}
_ = IncompleteUnknownInitSubclass(conveniently: 0) // okay

// FIXME: This initializer isn't being inherited for some reason, unrelated
// to the non-importable -initMissing:.
// https://bugs.swift.org/browse/SR-4566
_ = IncompleteUnknownInitSubclass(category: 0) // expected-error {{argument labels '(category:)' do not match any available overloads}} expected-note {{overloads}}
}