Skip to content

Commit

Permalink
[ApiCompat] Warn if abstract keyword is removed from member (#46797)
Browse files Browse the repository at this point in the history
  • Loading branch information
carlossanlop authored Feb 18, 2025
1 parent cbd3ca0 commit 88832fb
Show file tree
Hide file tree
Showing 16 changed files with 78 additions and 42 deletions.
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>
</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,
CreateDifferences()
};
// properties
yield return new object[] {
CreateType(" class", " public virtual int F { get; }"),
Expand Down Expand Up @@ -125,6 +139,13 @@ public static IEnumerable<object[]> AddedCasesStrictMode()
true,
CreateDifferences((DifferenceType.Added,"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() {}"),
true,
CreateDifferences((DifferenceType.Removed, "M:CompatTests.First.F")),
};
// abstract -> virtual
yield return new object[] {
CreateType(" abstract class", " public abstract void F();"),
Expand Down

0 comments on commit 88832fb

Please sign in to comment.