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.

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

Jump to bottom

[Java.Interop] Enable PublicApiAnalyzers to prevent API contract breakage. #1170

Merged
merged 3 commits into from
Dec 1, 2023
Merged

[Java.Interop] Enable PublicApiAnalyzers to prevent API contract breakage. #1170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0d420e
[Java.Interop] Enable PublicApiAnalyzers to prevent API contract brea…
jpobst Nov 27, 2023
82f6342
Fix RS0041 warnings.
jonpryor Nov 29, 2023
2309808
Update `PublicAPI.Shipped.txt`.
jpobst Nov 29, 2023
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
7 changes: 4 additions & 3 deletions build-tools/jnienv-gen/Generator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ static void GenerateFile (TextWriter o)
o.WriteLine ("// Generated file; DO NOT EDIT!");
o.WriteLine ("//");
o.WriteLine ("// To make changes, edit monodroid/tools/jnienv-gen-interop and rerun");
o.WriteLine ("#nullable enable");
o.WriteLine ();
o.WriteLine ("#if !FEATURE_JNIENVIRONMENT_SAFEHANDLES && !FEATURE_JNIENVIRONMENT_JI_INTPTRS && !FEATURE_JNIENVIRONMENT_JI_PINVOKES && !FEATURE_JNIENVIRONMENT_XA_INTPTRS && !FEATURE_JNIENVIRONMENT_JI_FUNCTION_POINTERS");
o.WriteLine ("#define FEATURE_JNIENVIRONMENT_JI_PINVOKES");
Expand Down Expand Up @@ -255,7 +256,7 @@ static void GenerateJniNativeInterfaceInvoker (TextWriter o, HandleStyle style)
if (e.Prebind)
o.WriteLine ("\t\tpublic readonly {0} {1};\n", d, e.Name);
else {
o.WriteLine ("\t\t{0} _{1};", d, e.Name);
o.WriteLine ("\t\t{0}? _{1};", d, e.Name);
o.WriteLine ("\t\tpublic {0} {1} {{", d, e.Name);
o.WriteLine ("\t\t\tget {");
o.WriteLine ("\t\t\t\tif (_{0} == null)\n\t\t\t\t\t{1}", e.Name, Initialize (e, "_", d));
Expand Down Expand Up @@ -551,7 +552,7 @@ static void RaiseException (TextWriter o, JniFunction entry, HandleStyle style)
return;

o.WriteLine ();
o.WriteLine ("\t\t\tException __e = JniEnvironment.GetExceptionForLastThrowable ({0});",
o.WriteLine ("\t\t\tException? __e = JniEnvironment.GetExceptionForLastThrowable ({0});",
(style == HandleStyle.JIIntPtrPinvokeWithErrors || style == HandleStyle.JIFunctionPtrWithErrors)
? "thrown"
: "");
Expand Down Expand Up @@ -1127,7 +1128,7 @@ public override string[] GetMarshalToManagedStatements (HandleStyle style, strin
case HandleStyle.JIFunctionPtrWithErrors:
return new[] {
string.Format ("if ({0} == IntPtr.Zero)", variable),
string.Format ("\treturn null;"),
string.Format ($"\tthrow new InvalidOperationException (\"Should not be reached; `{entry.Name}` should have thrown!\");"),
string.Format ("return new {0} ({1}, {2}, {3}, isStatic: {4});", type, entry.Parameters [1].Name, entry.Parameters [2].Name, variable, IsStatic ? "true" : "false"),
};
case HandleStyle.XAIntPtr:
Expand Down
15 changes: 4 additions & 11 deletions src/Java.Interop/Java.Interop.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,18 +88,11 @@
<DependentUpon>JniPeerMembers.JniInstanceMethods_Invoke.tt</DependentUpon>
</Compile>
</ItemGroup>
<ProjectExtensions>
<MonoDevelop>
<Properties>
<Policies>
<VersionControlPolicy>
<CommitMessageStyle Indent="&#x9;" LineAlign="0" IncludeDirectoryPaths="True" />
</VersionControlPolicy>
</Policies>
</Properties>
</MonoDevelop>
</ProjectExtensions>
<ItemGroup>
<PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="3.3.4">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Microsoft.SourceLink.GitHub" PrivateAssets="All" />
</ItemGroup>
<Import Project="Java.Interop.targets" />
Expand Down
4 changes: 4 additions & 0 deletions src/Java.Interop/Java.Interop/JavaObjectArray.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ public class JavaObjectArray<T> : JavaArray<T>
{
internal static readonly ValueMarshaler Instance = new ValueMarshaler ();

[SuppressMessage ("ApiDesign", "RS0022:Constructor make noninheritable base class inheritable", Justification = "Existing public API")]
public JavaObjectArray (ref JniObjectReference handle, JniObjectReferenceOptions options)
: base (ref handle, options)
{
Expand All @@ -29,20 +30,23 @@ static JniObjectReference NewArray (int length)
}
}

[SuppressMessage ("ApiDesign", "RS0022:Constructor make noninheritable base class inheritable", Justification = "Existing public API")]
public unsafe JavaObjectArray (int length)
: this (ref *InvalidJniObjectReference, JniObjectReferenceOptions.None)
{
var peer = NewArray (CheckLength (length));
Construct (ref peer, JniObjectReferenceOptions.CopyAndDispose);
}

[SuppressMessage ("ApiDesign", "RS0022:Constructor make noninheritable base class inheritable", Justification = "Existing public API")]
public JavaObjectArray (IList<T> value)
: this (CheckLength (value))
{
for (int i = 0; i < value.Count; ++i)
SetElementAt (i, value [i]);
}

[SuppressMessage ("ApiDesign", "RS0022:Constructor make noninheritable base class inheritable", Justification = "Existing public API")]
public JavaObjectArray (IEnumerable<T> value)
: this (ToList (value))
{
Expand Down
2 changes: 1 addition & 1 deletion src/Java.Interop/Java.Interop/JniEnvironment.Types.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ public static void RegisterNatives (JniObjectReference type, JniNativeMethodRegi
}
#endif // DEBUG && NETCOREAPP

int r = _RegisterNatives (type, methods, numMethods);
int r = _RegisterNatives (type, methods ?? Array.Empty<JniNativeMethodRegistration>(), numMethods);

if (r != 0) {
throw new InvalidOperationException (
Expand Down
3 changes: 3 additions & 0 deletions src/Java.Interop/Java.Interop/JniValueMarshaler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public struct JniValueMarshalerState : IEquatable<JniValueMarshalerState> {
public IJavaPeerable? PeerableValue {get; private set;}
public object? Extra {get; private set;}

[SuppressMessage ("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Existing public API")]
public JniValueMarshalerState (JniArgumentValue jniArgumentValue, object? extra = null)
{
JniArgumentValue = jniArgumentValue;
Expand All @@ -57,6 +58,7 @@ public JniValueMarshalerState (JniArgumentValue jniArgumentValue, object? extra
Extra = extra;
}

[SuppressMessage ("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Existing public API")]
public JniValueMarshalerState (JniObjectReference referenceValue, object? extra = null)
{
JniArgumentValue = new JniArgumentValue (referenceValue);
Expand All @@ -65,6 +67,7 @@ public JniValueMarshalerState (JniObjectReference referenceValue, object? extra
Extra = extra;
}

[SuppressMessage ("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Existing public API")]
public JniValueMarshalerState (IJavaPeerable? peerableValue, object? extra = null)
{
PeerableValue = peerableValue;
Expand Down
Loading