Skip to content

[ClangImporter] Add @available(*, renamed:) to imported async getters #38688

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.

Sign up for GitHub

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 1 commit into from
Jul 29, 2021
+38 −9
Merged

[ClangImporter] Add @available(*, renamed:) to imported async getters #38688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 17 additions & 1 deletion lib/AST/Attr.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -884,7 +884,23 @@ bool DeclAttribute::printImpl(ASTPrinter &Printer, const PrintOptions &Options,
if (!Attr->Rename.empty()) {
Printer << ", renamed: \"" << Attr->Rename << "\"";
} else if (Attr->RenameDecl) {
Printer << ", renamed: \"" << Attr->RenameDecl->getName() << "\"";
Printer << ", renamed: \"";
if (auto *Accessor = dyn_cast<AccessorDecl>(Attr->RenameDecl)) {
switch (Accessor->getAccessorKind()) {
case AccessorKind::Get:
Printer << "getter:";
break;
case AccessorKind::Set:
Printer << "setter:";
break;
default:
break;
}
Printer << Accessor->getStorage()->getName() << "()";
} else {
Printer << Attr->RenameDecl->getName();
}
Printer << "\"";
}

// If there's no message, but this is specifically an imported
Expand Down
9 changes: 8 additions & 1 deletion lib/ClangImporter/ImportDecl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8161,11 +8161,18 @@ void addCompletionHandlerAttribute(Decl *asyncImport,
ArrayRef<Decl *> members,
ASTContext &SwiftContext) {
auto *asyncFunc = dyn_cast_or_null<AbstractFunctionDecl>(asyncImport);
// Completion handler functions can be imported as getters, but the decl
// given back from the import is the property. Grab the underlying getter
if (auto *property = dyn_cast_or_null<AbstractStorageDecl>(asyncImport))
asyncFunc = property->getAccessor(AccessorKind::Get);

if (!asyncFunc)
return;

for (auto *member : members) {
if (member != asyncImport) {
// Only add the attribute to functions that don't already have availability
if (member != asyncImport && isa<AbstractFunctionDecl>(member) &&
!member->getAttrs().hasAttribute<AvailableAttr>()) {
member->getAttrs().add(
AvailableAttr::createForAlternative(SwiftContext, asyncFunc));
}
Expand Down
20 changes: 13 additions & 7 deletions test/IDE/print_clang_objc_effectful_properties.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,32 @@
// REQUIRES: objc_interop

// CHECK-LABEL: class EffProps : NSObject {
// CHECK: func getDogWithCompletion(_ completionHandler: @escaping (NSObject) -> Void)
// CHECK: var doggo: NSObject { get async }
// CHECK: @available(*, renamed: "getter:doggo()")
// CHECK-NEXT: func getDogWithCompletion(_ completionHandler: @escaping (NSObject) -> Void)
// CHECK: var doggo: NSObject { get async }

// CHECK: func obtainCat(_ completionHandler: @escaping (NSObject?, Error?) -> Void)
// CHECK: @available(*, renamed: "getter:catto()")
// CHECK-NEXT: func obtainCat(_ completionHandler: @escaping (NSObject?, Error?) -> Void)
// CHECK-NEXT: var catto: NSObject? { get async throws }

// CHECK: func checkAvailability(completionHandler: @escaping (Bool) -> Void)
// CHECK: @available(*, renamed: "getter:available()")
// CHECK-NEXT: func checkAvailability(completionHandler: @escaping (Bool) -> Void)
// CHECK-NEXT: var available: Bool { get async }
// CHECK-NEXT: @available(swift, obsoleted: 3, renamed: "checkAvailability(completionHandler:)")
// CHECK-NEXT: func checkAvailabilityWithCompletionHandler(_ completionHandler: @escaping (Bool) -> Void)

// CHECK: func returnNothing(completion completionHandler: @escaping () -> Void)
// CHECK: @available(*, renamed: "getter:touch()")
// CHECK-NEXT: func returnNothing(completion completionHandler: @escaping () -> Void)
// CHECK-NEXT: var touch: Void { get async }
// CHECK-NEXT: @available(swift, obsoleted: 3, renamed: "returnNothing(completion:)")
// CHECK-NEXT: func returnNothingWithCompletion(_ completionHandler: @escaping () -> Void)

// CHECK: func nullableHandler(_ completion: ((String) -> Void)? = nil)
// CHECK: @available(*, renamed: "getter:fromNullableHandler()")
// CHECK-NEXT: func nullableHandler(_ completion: ((String) -> Void)? = nil)
// CHECK-NEXT: var fromNullableHandler: String { get async }

// CHECK: func getMainDog(_ completion: @escaping (String) -> Void)
// CHECK: @available(*, renamed: "getter:mainDogProp()")
// CHECK-NEXT: func getMainDog(_ completion: @escaping (String) -> Void)
// CHECK-NEXT: var mainDogProp: String { get async }

// CHECK: @available(*, renamed: "regularMainDog()")
Expand Down