Skip to content

[generator] Don't mark a method as [UnsupportedOSPlatform] if it overrides a supported base method. #1313

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
jonpryor merged 1 commit into from
Feb 24, 2025
Merged

[generator] Don't mark a method as [UnsupportedOSPlatform] if it overrides a supported base method. #1313

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
33 changes: 33 additions & 0 deletions tests/generator-Tests/Unit-Tests/CodeGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1436,6 +1436,39 @@ public void UnsupportedOSPlatformConstFields ()
StringAssert.Contains ("[global::System.Runtime.Versioning.UnsupportedOSPlatformAttribute (\"android30.0\")]", builder.ToString (), "Should contain UnsupportedOSPlatform!");
}


[Test]
public void UnsupportedOSPlatformIgnoresMethodOverrides ()
{
// Given:
// public class TextView {
// public Object doThing () { ... }
// }
// public class TextView2 : TextView {
// public Object doThing () { ... } // removed-since = 30
// }
// We should not write [UnsupportedOSPlatform] on TextView2.doThing (), because the base method isn't "removed".
var xml = @$"<api>
<package name='java.lang' jni-name='java/lang'>
<class abstract='false' deprecated='not deprecated' final='false' name='Object' static='false' visibility='public' jni-signature='Ljava/lang/Object;' />
</package>
<package name='android.widget' jni-name='android/widget'>
<class abstract='false' deprecated='not deprecated' extends='java.lang.Object' extends-generic-aware='java.lang.Object' final='false' name='TextView' static='false' visibility='public'>
<method abstract='false' deprecated='not deprecated' final='false' name='doThing' bridge='false' native='false' return='java.lang.Object' static='false' synchronized='false' synthetic='false' visibility='public' />
</class>
<class abstract='false' deprecated='not deprecated' extends='android.widget.TextView' extends-generic-aware='java.lang.Object' final='false' name='TextView2' static='false' visibility='public'>
<method abstract='false' deprecated='not deprecated' final='false' name='doThing' bridge='false' native='false' return='java.lang.Object' static='false' synchronized='false' synthetic='false' visibility='public' removed-since='30' />
</class>
</package>
</api>";

var gens = ParseApiDefinition (xml);
var klass = gens.Single (g => g.Name == "TextView2");
var actual = GetGeneratedTypeOutput (klass);

StringAssert.DoesNotContain ("[global::System.Runtime.Versioning.UnsupportedOSPlatformAttribute (\"android30.0\")]", actual, "Should contain UnsupportedOSPlatform!");
}

[Test]
public void StringPropertyOverride ([Values ("true", "false")] string final)
{
Expand Down
5 changes: 5 additions & 0 deletions tools/generator/Java.Interop.Tools.Generator.ObjectModel/GenBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,11 @@ public void FixupMethodOverrides (CodeGenerationOptions opt)
m.DeprecatedSince = bm.DeprecatedSince;
}

// If a "removed" method overrides a "not removed" method, the method was
// likely moved to a base class, so don't mark it as removed.
if (m.ApiRemovedSince > 0 && bm.ApiRemovedSince == 0)
m.ApiRemovedSince = 0;

break;
}
}
Expand Down