[Java.Interop] Typemap support for JavaObject & [JniTypeSignature]

Context: dotnet/android#8543
Context: dotnet/android#8625
Context: #1168
Context: def5bc0
Context: 005c914

dotnet/android#8543 tested PR #1168, was Totally Green™ --
finding no issues -- and so we merged PR #1168 into 005c914.

Enter dotnet/android#8625, which bumps xamarin-android to
use def5bc0, which includes 005c914.  dotnet/android#8625
contains *failing unit tests* (?!), including
`Java.InteropTests.InvokeVirtualFromConstructorTests()`:

	Java.Lang.LinkageError : net.dot.jni.test.CallVirtualFromConstructorDerived
	----> System.NotSupportedException : Could not find System.Type corresponding to Java type JniTypeSignature(TypeName=net/dot/jni/test/CallVirtualFromConstructorDerived ArrayRank=0 Keyword=False) .
	   at Java.Interop.JniEnvironment.StaticMethods.GetStaticMethodID(JniObjectReference , String , String )
	   at Java.Interop.JniType.GetStaticMethod(String , String )
	   at Java.Interop.JniPeerMembers.JniStaticMethods.GetMethodInfo(String , String )
	   at Java.Interop.JniPeerMembers.JniStaticMethods.GetMethodInfo(String )
	   at Java.Interop.JniPeerMembers.JniStaticMethods.InvokeObjectMethod(String , JniArgumentValue* )
	   at Java.InteropTests.CallVirtualFromConstructorDerived.NewInstance(Int32 value)
	   at Java.InteropTests.InvokeVirtualFromConstructorTests.ActivationConstructor()
	   at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args)
	   at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object , BindingFlags )
	  --- End of managed Java.Lang.LinkageError stack trace ---
	java.lang.NoClassDefFoundError: net.dot.jni.test.CallVirtualFromConstructorDerived
		at crc643df67da7b13bb6b1.TestInstrumentation_1.n_onStart(Native Method)
		at crc643df67da7b13bb6b1.TestInstrumentation_1.onStart(TestInstrumentation_1.java:35)
		at android.app.Instrumentation$InstrumentationThread.run(Instrumentation.java:2189)
	Caused by: android.runtime.JavaProxyThrowable: [System.NotSupportedException]: Could not find System.Type corresponding to Java type JniTypeSignature(TypeName=net/dot/jni/test/CallVirtualFromConstructorDerived ArrayRank=0 Keyword=False) .
		at Java.Interop.ManagedPeer.GetTypeFromSignature(Unknown Source:0)
		at Java.Interop.ManagedPeer.RegisterNativeMembers(Unknown Source:0)
		at net.dot.jni.ManagedPeer.registerNativeMembers(Native Method)
		at net.dot.jni.test.CallVirtualFromConstructorDerived.<clinit>(CallVirtualFromConstructorDerived.java:12)
		... 3 more

	--NotSupportedException
	   at Java.Interop.ManagedPeer.GetTypeFromSignature(JniTypeManager , JniTypeSignature , String )
	   at Java.Interop.ManagedPeer.RegisterNativeMembers(IntPtr jnienv, IntPtr klass, IntPtr n_nativeClass, IntPtr n_methods)

:shocked-pikachu-face: (But dotnet/android#8543 was green!)

The problem is twofold:

 1. 005c914 now requires the presence of typemap entries from e.g.
    `Java.InteropTests.CallVirtualFromConstructorDerived` to
    `net.dot.jni.test.CallVirtualFromConstructorDerived`.

 2. `Java.Interop.Tools.JavaCallableWrappers` et al doesn't create
    typemap entries for `Java.Interop.JavaObject` subclasses which
    have `[JniTypeSignature]`.

Consequently, our units tests fail (and apparently weren't *run* on
dotnet/android#8543?!  Still not what happened.)

Fix typemap generation by adding a new `TypeDefinition.HasJavaPeer()`
extension method to replace all the `.IsSubclassOf("Java.Lang.Object")`
and similar checks, extending it to also check for
`Java.Interop.JavaObject` and `Java.Interop.JavaException` base types.
(Continuing to use base type checks is done instead of just relying
on implementation of `Java.Interop.IJavaPeerable` as a performance
optimization, as there could be *lots* of interface types to check.)

Additionally, @jonathanpeppers -- while trying to investigate all
this -- ran across a build failure:

	obj\Debug\net9.0-android\android\src\java\lang\Object.java(7,15): javac.exe error JAVAC0000:  error: cyclic inheritance involving Object

This suggests that `Java.Interop.Tools.JavaCallableWrappers` was
encountering `Java.Interop.JavaObject` -- or some other type which
has `[JniTypeSignature("java/lang/Object")]` -- which is why
`java/lang/Object.java` was being generated.

Audit all `[JniTypeSignature]` attributes, and add
`GenerateJavaPeer=false` to all types which should *not* hava a
Java Callable Wrapper generated for them.  This includes nearly
everything within `Java.Interop-Tests.dll`.  (We want the typemaps!
We *don't* want generated Java source, as we have hand-written Java
peer types for those tests.)

---

Aside: this project includes [T4 Text Templates][0].  To regenerate
the output files *without involving Visual Studio*, you can install
the [`dotnet-t4`][1] tool:

	$ dotnet tool install --global dotnet-t4

then run it separately for each `.tt` file:

	$HOME/.dotnet/tools/t4 -o src/Java.Interop/Java.Interop/JavaPrimitiveArrays.cs \
	  src/Java.Interop/Java.Interop/JavaPrimitiveArrays.tt

[0]: https://learn.microsoft.com/visualstudio/modeling/code-generation-and-t4-text-templates?view=vs-2022
[1]: https://www.nuget.org/packages/dotnet-t4/

Author: jonpryor

src/Java.Interop.Dynamic/Java.Interop.Dynamic/JavaInstanceProxy.cs

@@ -13,7 +13,7 @@
 
 namespace Java.Interop.Dynamic {
 
-	[JniTypeSignature ("java/lang/Object")]
+	[JniTypeSignature ("java/lang/Object", GenerateJavaPeer=false)]
 	class JavaInstanceProxy : JavaObject {
 
 		public JavaInstanceProxy (ref JniObjectReference reference, JniObjectReferenceOptions transfer)

src/Java.Interop.Tools.Cecil/Java.Interop.Tools.Cecil/TypeDefinitionRocks.cs

@@ -92,6 +92,25 @@ public static bool IsSubclassOf (this TypeDefinition type, string typeName, IMet
 			return false;
 		}
 
+		public static bool HasJavaPeer (this TypeDefinition type, IMetadataResolver resolver)
+		{
+			if (type.IsInterface && type.ImplementsInterface ("Java.Interop.IJavaPeerable", resolver))
+				return true;
+
+			foreach (var t in type.GetTypeAndBaseTypes (resolver)) {
+				switch (t.FullName) {
+					case "Java.Lang.Object":
+					case "Java.Lang.Throwable":
+					case "Java.Interop.JavaObject":
+					case "Java.Interop.JavaException":
+						return true;
+					default:
+						break;
+				}
+			}
+			return false;
+		}
+
 		[Obsolete ("Use the TypeDefinitionCache overload for better performance.", error: true)]
 		public static bool ImplementsInterface (this TypeDefinition type, string interfaceName) => throw new NotSupportedException ();
 

src/Java.Interop.Tools.JavaCallableWrappers/Java.Interop.Tools.JavaCallableWrappers/JavaCallableWrapperGenerator.cs

@@ -121,7 +121,7 @@ void AddNestedTypes (TypeDefinition type)
 			}
 			children = children ?? new List<JavaCallableWrapperGenerator> ();
 			foreach (TypeDefinition nt in type.NestedTypes) {
-				if (!nt.IsSubclassOf ("Java.Lang.Object", cache))
+				if (!nt.HasJavaPeer (cache))
 					continue;
 				if (!JavaNativeTypeManager.IsNonStaticInnerClass (nt, cache))
 					continue;

src/Java.Interop.Tools.JavaCallableWrappers/Java.Interop.Tools.JavaCallableWrappers/JavaTypeScanner.cs

@@ -66,10 +66,7 @@ public List<TypeDefinition> GetJavaTypes (AssemblyDefinition assembly)
 
 		void AddJavaTypes (List<TypeDefinition> javaTypes, TypeDefinition type)
 		{
-			if (type.IsSubclassOf ("Java.Lang.Object", cache) ||
-					type.IsSubclassOf ("Java.Lang.Throwable", cache) ||
-					(type.IsInterface && type.ImplementsInterface ("Java.Interop.IJavaPeerable", cache))) {
-				// For subclasses of e.g. Android.App.Activity.
+			if (type.HasJavaPeer (cache)) {
 				javaTypes.Add (type);
 			} else if (type.IsClass && !type.IsSubclassOf ("System.Exception", cache) && type.ImplementsInterface ("Android.Runtime.IJavaObject", cache)) {
 				var level   = ErrorOnCustomJavaObject ? TraceLevel.Error : TraceLevel.Warning;

src/Java.Interop.Tools.TypeNameMappings/Java.Interop.Tools.TypeNameMappings/JavaNativeTypeManager.cs

@@ -717,7 +717,7 @@ internal static bool IsNonStaticInnerClass (TypeDefinition? type, IMetadataResol
 			if (!type.IsNested)
 				return false;
 
-			if (!type.DeclaringType.IsSubclassOf ("Java.Lang.Object", cache))
+			if (!type.DeclaringType.HasJavaPeer (cache))
 				return false;
 
 			foreach (var baseType in type.GetBaseTypes (cache)) {

src/Java.Interop/Java.Interop/JavaException.cs

@@ -4,7 +4,7 @@
 
 namespace Java.Interop
 {
-	[JniTypeSignature (JniTypeName)]
+	[JniTypeSignature (JniTypeName, GenerateJavaPeer=false)]
 	unsafe public class JavaException : Exception, IJavaPeerable
 	{
 		internal    const   string          JniTypeName = "java/lang/Throwable";

src/Java.Interop/Java.Interop/JavaObject.cs

@@ -4,7 +4,7 @@
 
 namespace Java.Interop
 {
-	[JniTypeSignature ("java/lang/Object")]
+	[JniTypeSignature ("java/lang/Object", GenerateJavaPeer=false)]
 	unsafe public class JavaObject : IJavaPeerable
 	{
 		readonly static JniPeerMembers _members = new JniPeerMembers ("java/lang/Object", typeof (JavaObject));

src/Java.Interop/Java.Interop/JavaPrimitiveArrays.cs

@@ -142,7 +142,7 @@ protected override unsafe void Synchronize (JniReleaseArrayElementsMode releaseM
 		}
 	}
 
-	[JniTypeSignature ("Z", ArrayRank=1, IsKeyword=true)]
+	[JniTypeSignature ("Z", ArrayRank=1, IsKeyword=true, GenerateJavaPeer=false)]
 	public sealed class JavaBooleanArray : JavaPrimitiveArray<Boolean> {
 
 		internal    static  readonly    ValueMarshaler   ArrayMarshaler     = new ValueMarshaler ();
@@ -337,7 +337,7 @@ protected override unsafe void Synchronize (JniReleaseArrayElementsMode releaseM
 		}
 	}
 
-	[JniTypeSignature ("B", ArrayRank=1, IsKeyword=true)]
+	[JniTypeSignature ("B", ArrayRank=1, IsKeyword=true, GenerateJavaPeer=false)]
 	public sealed class JavaSByteArray : JavaPrimitiveArray<SByte> {
 
 		internal    static  readonly    ValueMarshaler   ArrayMarshaler     = new ValueMarshaler ();
@@ -532,7 +532,7 @@ protected override unsafe void Synchronize (JniReleaseArrayElementsMode releaseM
 		}
 	}
 
-	[JniTypeSignature ("C", ArrayRank=1, IsKeyword=true)]
+	[JniTypeSignature ("C", ArrayRank=1, IsKeyword=true, GenerateJavaPeer=false)]
 	public sealed class JavaCharArray : JavaPrimitiveArray<Char> {
 
 		internal    static  readonly    ValueMarshaler   ArrayMarshaler     = new ValueMarshaler ();
@@ -727,7 +727,7 @@ protected override unsafe void Synchronize (JniReleaseArrayElementsMode releaseM
 		}
 	}
 
-	[JniTypeSignature ("S", ArrayRank=1, IsKeyword=true)]
+	[JniTypeSignature ("S", ArrayRank=1, IsKeyword=true, GenerateJavaPeer=false)]
 	public sealed class JavaInt16Array : JavaPrimitiveArray<Int16> {
 
 		internal    static  readonly    ValueMarshaler   ArrayMarshaler     = new ValueMarshaler ();
@@ -922,7 +922,7 @@ protected override unsafe void Synchronize (JniReleaseArrayElementsMode releaseM
 		}
 	}
 
-	[JniTypeSignature ("I", ArrayRank=1, IsKeyword=true)]
+	[JniTypeSignature ("I", ArrayRank=1, IsKeyword=true, GenerateJavaPeer=false)]
 	public sealed class JavaInt32Array : JavaPrimitiveArray<Int32> {
 
 		internal    static  readonly    ValueMarshaler   ArrayMarshaler     = new ValueMarshaler ();
@@ -1117,7 +1117,7 @@ protected override unsafe void Synchronize (JniReleaseArrayElementsMode releaseM
 		}
 	}
 
-	[JniTypeSignature ("J", ArrayRank=1, IsKeyword=true)]
+	[JniTypeSignature ("J", ArrayRank=1, IsKeyword=true, GenerateJavaPeer=false)]
 	public sealed class JavaInt64Array : JavaPrimitiveArray<Int64> {
 
 		internal    static  readonly    ValueMarshaler   ArrayMarshaler     = new ValueMarshaler ();
@@ -1312,7 +1312,7 @@ protected override unsafe void Synchronize (JniReleaseArrayElementsMode releaseM
 		}
 	}
 
-	[JniTypeSignature ("F", ArrayRank=1, IsKeyword=true)]
+	[JniTypeSignature ("F", ArrayRank=1, IsKeyword=true, GenerateJavaPeer=false)]
 	public sealed class JavaSingleArray : JavaPrimitiveArray<Single> {
 
 		internal    static  readonly    ValueMarshaler   ArrayMarshaler     = new ValueMarshaler ();
@@ -1507,7 +1507,7 @@ protected override unsafe void Synchronize (JniReleaseArrayElementsMode releaseM
 		}
 	}
 
-	[JniTypeSignature ("D", ArrayRank=1, IsKeyword=true)]
+	[JniTypeSignature ("D", ArrayRank=1, IsKeyword=true, GenerateJavaPeer=false)]
 	public sealed class JavaDoubleArray : JavaPrimitiveArray<Double> {
 
 		internal    static  readonly    ValueMarshaler   ArrayMarshaler     = new ValueMarshaler ();

src/Java.Interop/Java.Interop/JavaPrimitiveArrays.tt

@@ -139,7 +139,7 @@ namespace Java.Interop {
 		}
 	}
 
-	[JniTypeSignature ("<#= info.JniType #>", ArrayRank=1, IsKeyword=true)]
+	[JniTypeSignature ("<#= info.JniType #>", ArrayRank=1, IsKeyword=true, GenerateJavaPeer=false)]
 	public sealed class Java<#= info.TypeModifier #>Array : JavaPrimitiveArray<<#= info.ManagedType #>> {
 
 		internal    static  readonly    ValueMarshaler   ArrayMarshaler     = new ValueMarshaler ();

src/Java.Interop/Java.Interop/JavaProxyObject.cs

@@ -7,7 +7,7 @@
 
 namespace Java.Interop {
 
-	[JniTypeSignature (JniTypeName)]
+	[JniTypeSignature (JniTypeName, GenerateJavaPeer=false)]
 	sealed class JavaProxyObject : JavaObject, IEquatable<JavaProxyObject>
 	{
 		internal const string JniTypeName = "net/dot/jni/internal/JavaProxyObject";