Skip to content

Add a Fix-It to the warning about unnecessary @preconcurrency conformance #73742

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
May 20, 2024
Merged

Add a Fix-It to the warning about unnecessary @preconcurrency conformance #73742

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
3 changes: 2 additions & 1 deletion include/swift/AST/ASTContext.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1238,7 +1238,8 @@ class ASTContext final {
DeclContext *dc,
ProtocolConformanceState state,
bool isUnchecked,
bool isPreconcurrency);
bool isPreconcurrency,
SourceLoc preconcurrencyLoc = SourceLoc());

/// Produce a self-conformance for the given protocol.
SelfProtocolConformance *
Expand Down
15 changes: 12 additions & 3 deletions include/swift/AST/ProtocolConformance.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,6 +530,9 @@ class NormalProtocolConformance : public RootProtocolConformance,
/// The location of this protocol conformance in the source.
SourceLoc Loc;

/// The location of the `@preconcurrency` attribute, if any.
SourceLoc PreconcurrencyLoc;

/// The declaration context containing the ExtensionDecl or
/// NominalTypeDecl that declared the conformance.
DeclContext *Context;
Expand Down Expand Up @@ -562,10 +565,12 @@ class NormalProtocolConformance : public RootProtocolConformance,
NormalProtocolConformance(Type conformingType, ProtocolDecl *protocol,
SourceLoc loc, DeclContext *dc,
ProtocolConformanceState state, bool isUnchecked,
bool isPreconcurrency)
bool isPreconcurrency,
SourceLoc preconcurrencyLoc)
: RootProtocolConformance(ProtocolConformanceKind::Normal,
conformingType),
Protocol(protocol), Loc(loc), Context(dc) {
Protocol(protocol), Loc(loc), PreconcurrencyLoc(preconcurrencyLoc),
Context(dc) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please add an assert to make sure that preconcurrencyLoc is never valid when isPreconcurrency is set to false?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, good idea!

assert(!conformingType->hasArchetype() &&
"ProtocolConformances should store interface types");
setState(state);
Expand All @@ -580,7 +585,7 @@ class NormalProtocolConformance : public RootProtocolConformance,
/// Get the protocol being conformed to.
ProtocolDecl *getProtocol() const { return Protocol; }

/// Retrieve the location of this
/// Retrieve the location of this conformance.
SourceLoc getLoc() const { return Loc; }

/// Get the declaration context that contains the conforming extension or
Expand Down Expand Up @@ -629,6 +634,10 @@ class NormalProtocolConformance : public RootProtocolConformance,
return Bits.NormalProtocolConformance.IsPreconcurrency;
}

/// Retrieve the location of `@preconcurrency`, if there is one and it is
/// known.
SourceLoc getPreconcurrencyLoc() const { return PreconcurrencyLoc; }

/// Determine whether we've lazily computed the associated conformance array
/// already.
bool hasComputedAssociatedConformances() const {
Expand Down
5 changes: 3 additions & 2 deletions lib/AST/ASTContext.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2593,7 +2593,8 @@ ASTContext::getNormalConformance(Type conformingType,
DeclContext *dc,
ProtocolConformanceState state,
bool isUnchecked,
bool isPreconcurrency) {
bool isPreconcurrency,
SourceLoc preconcurrencyLoc) {
assert(dc->isTypeContext());

llvm::FoldingSetNodeID id;
Expand All @@ -2609,7 +2610,7 @@ ASTContext::getNormalConformance(Type conformingType,
// Build a new normal protocol conformance.
auto result = new (*this, AllocationArena::Permanent)
NormalProtocolConformance(conformingType, protocol, loc, dc, state,
isUnchecked, isPreconcurrency);
isUnchecked, isPreconcurrency, preconcurrencyLoc);
normalConformances.InsertNode(result, insertPos);

return result;
Expand Down
3 changes: 2 additions & 1 deletion lib/AST/ConformanceLookupTable.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -989,7 +989,8 @@ ConformanceLookupTable::getConformance(NominalTypeDecl *nominal,
conformingType, protocol, conformanceLoc, conformingDC,
ProtocolConformanceState::Incomplete,
entry->Source.getUncheckedLoc().isValid(),
entry->Source.getPreconcurrencyLoc().isValid());
entry->Source.getPreconcurrencyLoc().isValid(),
entry->Source.getPreconcurrencyLoc());
// Invalid code may cause the getConformance call below to loop, so break
// the infinite recursion by setting this eagerly to shortcircuit with the
// early return at the start of this function.
Expand Down
2 changes: 1 addition & 1 deletion lib/AST/TypeRepr.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ SourceLoc TypeRepr::findAttrLoc(TypeAttrKind kind) const {
for (auto attr : attrTypeRepr->getAttrs()) {
if (auto typeAttr = attr.dyn_cast<TypeAttribute*>())
if (typeAttr->getKind() == kind)
return typeAttr->getAttrLoc();
return typeAttr->getStartLoc();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking for what this change is going to affect and found https://github.com/apple/swift/blob/main/lib/Sema/TypeCheckDeclPrimary.cpp#L1803-L1806 which instead of 1 should also use strlen("@retroactive ")? We have a few tests for that diagnostic but none of them check fix-it :/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I'll do that. I feel like there should be a better way than that strlen, but I wasn't up for adding more infrastructure right now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What devilry is this? The .getAdvancedLoc(1) thing is actually working for @retroactive, and I don't understand why

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is weird...

}

typeRepr = attrTypeRepr->getTypeRepr();
Expand Down
9 changes: 8 additions & 1 deletion lib/Sema/TypeCheckProtocol.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5120,9 +5120,16 @@ void ConformanceChecker::resolveValueWitnesses() {
}

if (Conformance->isPreconcurrency() && !usesPreconcurrencyConformance) {
DC->getASTContext().Diags.diagnose(
auto diag = DC->getASTContext().Diags.diagnose(
Conformance->getLoc(), diag::preconcurrency_conformance_not_used,
Proto->getDeclaredInterfaceType());

SourceLoc preconcurrencyLoc = Conformance->getPreconcurrencyLoc();
if (preconcurrencyLoc.isValid()) {
SourceLoc endLoc =
preconcurrencyLoc.getAdvancedLoc(strlen("@preconcurrency "));
diag.fixItRemoveChars(preconcurrencyLoc, endLoc);
}
}

// Finally, check some ad-hoc protocol requirements.
Expand Down
4 changes: 2 additions & 2 deletions test/Concurrency/preconcurrency_conformances.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ protocol WithNonIsolated {

do {
class TestExplicitOtherIsolation : @preconcurrency WithNonIsolated {
// expected-warning@-1 {{@preconcurrency attribute on conformance to 'WithNonIsolated' has no effect}}
// expected-warning@-1 {{@preconcurrency attribute on conformance to 'WithNonIsolated' has no effect}}{{38-54=}}

@GlobalActor var prop: Int = 42
// expected-warning@-1 {{global actor 'GlobalActor'-isolated property 'prop' cannot be used to satisfy main actor-isolated protocol requirement}}
Expand All @@ -164,7 +164,7 @@ do {

do {
class InferredGlobalActorAttrs : @preconcurrency WithNonIsolated {
// expected-warning@-1 {{@preconcurrency attribute on conformance to 'WithNonIsolated' has no effect}}
// expected-warning@-1 {{@preconcurrency attribute on conformance to 'WithNonIsolated' has no effect}}{{36-52=}}
var prop: Int = 42
func test() {}
}
Expand Down