Skip to content
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

[ApiCompat] Warn if abstract keyword is removed from member #46797

Merged
merged 4 commits into from
Feb 18, 2025
Merged
Show file tree
Hide file tree
Changes from 3 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
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,8 @@
<data name="CannotAddVirtualToMember" xml:space="preserve">
<value>Cannot add virtual keyword to member '{0}'.</value>
</data>
<data name="CannotRemoveVirtualFromMember" xml:space="preserve">
<value>Cannot remove virtual keyword from member '{0}'.</value>
<data name="CannotRemoveVirtualOrAbstractFromMember" xml:space="preserve">
<value>Cannot remove '{0}' keyword from member '{1}'.</value>
ericstj marked this conversation as resolved.
Show resolved Hide resolved
</data>
<data name="ApiCompatibilityHeader" xml:space="preserve">
<value>API compatibility errors between '{0}' ({2}) and '{1}' ({3}):</value>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ private void RunOnMemberSymbol(ISymbol? left, ISymbol? right, ITypeSymbol leftCo
leftMetadata,
rightMetadata,
DiagnosticIds.CannotRemoveVirtualFromMember,
string.Format(Resources.CannotRemoveVirtualFromMember, left),
string.Format(Resources.CannotRemoveVirtualOrAbstractFromMember, "virtual", left),
DifferenceType.Removed,
right));
}
Expand All @@ -86,6 +86,21 @@ private void RunOnMemberSymbol(ISymbol? left, ISymbol? right, ITypeSymbol leftCo
right));
}
}

if (left.IsAbstract)
{
if (!right.IsAbstract && !right.IsVirtual)
{
// abstract can be made virtual but cannot remove abstract.
differences.Add(new CompatDifference(
leftMetadata,
rightMetadata,
DiagnosticIds.CannotRemoveVirtualFromMember,
string.Format(Resources.CannotRemoveVirtualOrAbstractFromMember, "abstract", left),
DifferenceType.Removed,
right));
}
}
}
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,20 @@ public static IEnumerable<object[]> RemovedCases()
false,
CreateDifferences((DifferenceType.Removed, "M:CompatTests.First.F")),
};
// remove abstract from member
yield return new object[] {
CreateType(" abstract class", " public abstract void F();"),
CreateType(" abstract class", " public void F() {}"),
false,
CreateDifferences((DifferenceType.Removed, "M:CompatTests.First.F")),
};
// replace abstract with virtual (no diffs expected)
yield return new object[] {
CreateType(" abstract class", " public abstract void F();"),
CreateType(" abstract class", " public virtual void F() {}"),
false,
new CompatDifference[] { }
carlossanlop marked this conversation as resolved.
Show resolved Hide resolved
};
// properties
yield return new object[] {
CreateType(" class", " public virtual int F { get; }"),
Expand Down
Loading