[generator] Emit partial method for peer constructor

Context: dotnet#1085
Context: dotnet/runtime#82121

Some Java objects are *big*, e.g. [`Bitmap`][0] instances, but as
far as MonoVM is concerned, the `Bitmap` instances are *tiny*: a
few pointers, and that's it.  MonoVM doesn't know that it could be
referencing several MB of data in the Java VM.

MonoVM is gaining support for [`GC.AddMemoryPressure()`][1] and
[`GC.RemoveMemoryPressure()`][2], which potentially allows for the
parent of all cross-VM GC integrations: using the `GC` methods to
inform MonoVM of how much non-managed memory has been allocated.
This could allow MonoVM to collect more frequently when total process
memory is low.

How should we call `GC.AddMemoryPressure()` and
`GC.RemoveMemoryPressure()`?

`GC.RemoveMemoryPressure()` is straightforward: a class can override
`Java.Lang.Object.Dispose(bool)`.

`GC.AddMemoryPressure()` is the problem: where and how can it be
called from a class binding?  This is trickier, as there was no way
to have custom code called by the bound type.  Instead, various
forms of "hacky workarounds" are often employed, e.g. copying
`generator`-emitted content into a `partial` class, then using
`metadata` to *prevent* `generator` from binding those members.
It's all around fugly.

Fortunately C# has a solution: [`partial` methods][3]!

We take our existing "peer constructor" generation code, a'la:

	partial class Bitmap : Java.Lang.Object {
	    internal Bitmap (IntPtr h, JniHandleOwnership t) : base (h, t)
	    {
	    }
	}

and extend it to:

	partial class Bitmap : Java.Lang.Object {
	    partial void _OnBitmapCreated ();
	    internal Bitmap (IntPtr h, JniHandleOwnership t) : base (h, t)
	    {
	        _OnBitmapCreated ();
	    }
	}

This allows a `partial class Bitmap` to do:

	// Hand-written code
	partial class Bitmap {
	    int _memoryPressure;

	    partial void _OnBitmapCreated ()
	    {
	        _memoryPressure = ByteCount;
	        GC.AddMemoryPressure (_memoryPressure);
	    }

	    protected override void Dispose (bool disposing)
	    {
	        if (_memoryPressure != 0) {
	            GC.RemoveMemoryPressure (_memoryPressure);
	            _memoryPressure = 0;
		}
	    }
	}

TODO: Are there any other places where such `partial` methods would
be useful?  This appears to be the minimum required for this scenario.

[0]: https://developer.android.com/reference/android/graphics/Bitmap
[1]: https://learn.microsoft.com/dotnet/api/system.gc.addmemorypressure?view=net-7.0
[2]: https://learn.microsoft.com/dotnet/api/system.gc.removememorypressure?view=net-7.0
[3]: https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/partial-method

Author: jonpryor

src/Xamarin.SourceWriter/Models/MethodWriter.cs

@@ -52,11 +52,16 @@ public void SetVisibility (string visibility)
 
 		public virtual void Write (CodeWriter writer)
 		{
+			WritePartialMethodDeclaration (writer);
 			WriteComments (writer);
 			WriteAttributes (writer);
 			WriteSignature (writer);
 		}
 
+		public virtual void WritePartialMethodDeclaration (CodeWriter writer)
+		{
+		}
+
 		public virtual void WriteComments (CodeWriter writer)
 		{
 			foreach (var c in Comments)

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/JavaInterop1/WriteClass.txt

@@ -3,8 +3,12 @@
 public partial class MyClass {
 	static readonly JniPeerMembers _members = new JniPeerMembers ("java/code/MyClass", typeof (MyClass));
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 	{
+		_OnMyClassCreated ();
 	}
 
 	// Metadata.xml XPath constructor reference: path="/api/package[@name='java.code']/class[@name='MyClass']/constructor[@name='MyClass' and count(parameter)=0]"

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/JavaInterop1/WriteKotlinUnsignedArrayTypeMethodsClass.txt

@@ -3,8 +3,12 @@
 public partial class MyClass {
 	static readonly JniPeerMembers _members = new JniPeerMembers ("java/code/MyClass", typeof (MyClass));
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 	{
+		_OnMyClassCreated ();
 	}
 
 	// Metadata.xml XPath method reference: path="/api/package[@name='java.code']/class[@name='MyClass']/method[@name='Echo' and count(parameter)=1 and parameter[1][@type='uint[]']]"

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/JavaInterop1/WriteKotlinUnsignedArrayTypePropertiesClass.txt

@@ -3,8 +3,12 @@
 public partial class MyClass {
 	static readonly JniPeerMembers _members = new JniPeerMembers ("java/code/MyClass", typeof (MyClass));
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 	{
+		_OnMyClassCreated ();
 	}
 
 	public unsafe Java.Interop.JavaInt32Array? UIntProp {

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/JavaInterop1/WriteKotlinUnsignedTypeMethodsClass.txt

@@ -3,8 +3,12 @@
 public partial class MyClass {
 	static readonly JniPeerMembers _members = new JniPeerMembers ("java/code/MyClass", typeof (MyClass));
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 	{
+		_OnMyClassCreated ();
 	}
 
 	// Metadata.xml XPath method reference: path="/api/package[@name='java.code']/class[@name='MyClass']/method[@name='Echo' and count(parameter)=1 and parameter[1][@type='uint']]"

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/JavaInterop1/WriteKotlinUnsignedTypePropertiesClass.txt

@@ -3,8 +3,12 @@
 public partial class MyClass {
 	static readonly JniPeerMembers _members = new JniPeerMembers ("java/code/MyClass", typeof (MyClass));
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 	{
+		_OnMyClassCreated ();
 	}
 
 	public unsafe uint UIntProp {

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/JavaInterop1/WriteMethodWithCharSequenceArrays.txt

@@ -9,8 +9,12 @@ public partial class MyClass : Java.Lang.Object {
 		get { return _members; }
 	}
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 	{
+		_OnMyClassCreated ();
 	}
 
 	// Metadata.xml XPath method reference: path="/api/package[@name='com.example']/class[@name='MyClass']/method[@name='echo' and count(parameter)=1 and parameter[1][@type='java.lang.CharSequence[]']]"

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/JavaInterop1/WriteObjectField.txt

@@ -23,8 +23,12 @@ public partial class MyClass {
 
 	static readonly JniPeerMembers _members = new JniPeerMembers ("java/code/MyClass", typeof (MyClass));
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 	{
+		_OnMyClassCreated ();
 	}
 
 }

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1-NRT/WriteClass.txt

@@ -7,8 +7,12 @@ public partial class MyClass {
 		get { return _members.JniPeerType.PeerReference.Handle; }
 	}
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (IntPtr javaReference, JniHandleOwnership transfer) : base (javaReference, transfer)
 	{
+		_OnMyClassCreated ();
 	}
 
 	// Metadata.xml XPath constructor reference: path="/api/package[@name='java.code']/class[@name='MyClass']/constructor[@name='MyClass' and count(parameter)=0]"

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1-NRT/WriteMethodWithCharSequenceArrays.txt

@@ -25,8 +25,12 @@ public partial class MyClass : Java.Lang.Object {
 		get { return _members.ManagedPeerType; }
 	}
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (IntPtr javaReference, JniHandleOwnership transfer) : base (javaReference, transfer)
 	{
+		_OnMyClassCreated ();
 	}
 
 	static Delegate? cb_echo_arrayLjava_lang_CharSequence_;

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1-NRT/WriteObjectField.txt

@@ -29,8 +29,12 @@ public partial class MyClass {
 		get { return _members.JniPeerType.PeerReference.Handle; }
 	}
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (IntPtr javaReference, JniHandleOwnership transfer) : base (javaReference, transfer)
 	{
+		_OnMyClassCreated ();
 	}
 
 }

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteClass.txt

@@ -7,8 +7,12 @@ public partial class MyClass {
 		get { return _members.JniPeerType.PeerReference.Handle; }
 	}
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (IntPtr javaReference, JniHandleOwnership transfer) : base (javaReference, transfer)
 	{
+		_OnMyClassCreated ();
 	}
 
 	// Metadata.xml XPath constructor reference: path="/api/package[@name='java.code']/class[@name='MyClass']/constructor[@name='MyClass' and count(parameter)=0]"

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteKotlinUnsignedArrayTypeMethodsClass.txt

@@ -7,8 +7,12 @@ public partial class MyClass {
 		get { return _members.JniPeerType.PeerReference.Handle; }
 	}
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (IntPtr javaReference, JniHandleOwnership transfer) : base (javaReference, transfer)
 	{
+		_OnMyClassCreated ();
 	}
 
 	// Metadata.xml XPath method reference: path="/api/package[@name='java.code']/class[@name='MyClass']/method[@name='Echo' and count(parameter)=1 and parameter[1][@type='uint[]']]"

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteKotlinUnsignedArrayTypePropertiesClass.txt

@@ -7,8 +7,12 @@ public partial class MyClass {
 		get { return _members.JniPeerType.PeerReference.Handle; }
 	}
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (IntPtr javaReference, JniHandleOwnership transfer) : base (javaReference, transfer)
 	{
+		_OnMyClassCreated ();
 	}
 
 	public unsafe uint[] UIntProp {

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteKotlinUnsignedTypeMethodsClass.txt

@@ -7,8 +7,12 @@ public partial class MyClass {
 		get { return _members.JniPeerType.PeerReference.Handle; }
 	}
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (IntPtr javaReference, JniHandleOwnership transfer) : base (javaReference, transfer)
 	{
+		_OnMyClassCreated ();
 	}
 
 	// Metadata.xml XPath method reference: path="/api/package[@name='java.code']/class[@name='MyClass']/method[@name='Echo' and count(parameter)=1 and parameter[1][@type='uint']]"

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteKotlinUnsignedTypePropertiesClass.txt

@@ -7,8 +7,12 @@ public partial class MyClass {
 		get { return _members.JniPeerType.PeerReference.Handle; }
 	}
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (IntPtr javaReference, JniHandleOwnership transfer) : base (javaReference, transfer)
 	{
+		_OnMyClassCreated ();
 	}
 
 	public unsafe uint UIntProp {

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteMethodWithCharSequenceArrays.txt

@@ -25,8 +25,12 @@ public partial class MyClass : Java.Lang.Object {
 		get { return _members.ManagedPeerType; }
 	}
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (IntPtr javaReference, JniHandleOwnership transfer) : base (javaReference, transfer)
 	{
+		_OnMyClassCreated ();
 	}
 
 	static Delegate cb_echo_arrayLjava_lang_CharSequence_;

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteNestedInterfaceClass.txt

@@ -34,8 +34,12 @@ public partial interface IParent : IJavaObject, IJavaPeerable {
 			get { return _members.ManagedPeerType; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnChildCreated ();
+
 		protected Child (IntPtr javaReference, JniHandleOwnership transfer) : base (javaReference, transfer)
 		{
+			_OnChildCreated ();
 		}
 
 	}

tests/generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteObjectField.txt

@@ -29,8 +29,12 @@ public partial class MyClass {
 		get { return _members.JniPeerType.PeerReference.Handle; }
 	}
 
+	/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+	partial void _OnMyClassCreated ();
+
 	protected MyClass (IntPtr javaReference, JniHandleOwnership transfer) : base (javaReference, transfer)
 	{
+		_OnMyClassCreated ();
 	}
 
 }

tests/generator-Tests/expected.ji/AccessModifiers/Xamarin.Test.BasePublicClass.cs

@@ -25,8 +25,12 @@ public partial class BasePublicClass : global::Java.Lang.Object {
 			get { return _members; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnBasePublicClassCreated ();
+
 		protected BasePublicClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 		{
+			_OnBasePublicClassCreated ();
 		}
 
 		// Metadata.xml XPath method reference: path="/api/package[@name='xamarin.test']/class[@name='BasePublicClass']/method[@name='baseMethod' and count(parameter)=0]"

tests/generator-Tests/expected.ji/AccessModifiers/Xamarin.Test.ExtendPublicClass.cs

@@ -25,8 +25,12 @@ public partial class ExtendPublicClass : global::Java.Lang.Object {
 			get { return _members; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnExtendPublicClassCreated ();
+
 		protected ExtendPublicClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 		{
+			_OnExtendPublicClassCreated ();
 		}
 
 		// Metadata.xml XPath constructor reference: path="/api/package[@name='xamarin.test']/class[@name='ExtendPublicClass']/constructor[@name='ExtendPublicClass' and count(parameter)=0]"

tests/generator-Tests/expected.ji/AccessModifiers/Xamarin.Test.PublicClass.cs

@@ -34,8 +34,12 @@ protected internal partial interface IProtectedInterface : IJavaPeerable {
 			get { return _members; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnPublicClassCreated ();
+
 		protected PublicClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 		{
+			_OnPublicClassCreated ();
 		}
 
 		// Metadata.xml XPath constructor reference: path="/api/package[@name='xamarin.test']/class[@name='PublicClass']/constructor[@name='PublicClass' and count(parameter)=0]"

tests/generator-Tests/expected.ji/AccessModifiers/Xamarin.Test.PublicFinalClass.cs

@@ -25,8 +25,12 @@ public sealed partial class PublicFinalClass : global::Xamarin.Test.BasePublicCl
 			get { return _members; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnPublicFinalClassCreated ();
+
 		internal PublicFinalClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 		{
+			_OnPublicFinalClassCreated ();
 		}
 
 		// Metadata.xml XPath method reference: path="/api/package[@name='xamarin.test']/class[@name='PublicFinalClass']/method[@name='publicMethod' and count(parameter)=0]"

tests/generator-Tests/expected.ji/AccessModifiers/Xamarin.Test.TestClass.cs

@@ -25,8 +25,12 @@ public partial class TestClass : global::Java.Lang.Object {
 			get { return _members; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnTestClassCreated ();
+
 		protected TestClass (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 		{
+			_OnTestClassCreated ();
 		}
 
 		// Metadata.xml XPath constructor reference: path="/api/package[@name='xamarin.test']/class[@name='TestClass']/constructor[@name='TestClass' and count(parameter)=0]"

tests/generator-Tests/expected.ji/Android.Graphics.Color/Xamarin.Test.SomeObject.cs

@@ -25,8 +25,12 @@ public abstract partial class SomeObject : global::Java.Lang.Object {
 			get { return _members; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnSomeObjectCreated ();
+
 		protected SomeObject (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 		{
+			_OnSomeObjectCreated ();
 		}
 
 	}

tests/generator-Tests/expected.ji/Arrays/Xamarin.Test.SomeObject.cs

@@ -165,8 +165,12 @@ public partial class SomeObject : global::Java.Lang.Object {
 			get { return _members; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnSomeObjectCreated ();
+
 		protected SomeObject (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 		{
+			_OnSomeObjectCreated ();
 		}
 
 	}

tests/generator-Tests/expected.ji/CSharpKeywords/Xamarin.Test.CSharpKeywords.cs

@@ -25,8 +25,12 @@ public partial class CSharpKeywords : global::Java.Lang.Object {
 			get { return _members; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnCSharpKeywordsCreated ();
+
 		protected CSharpKeywords (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 		{
+			_OnCSharpKeywordsCreated ();
 		}
 
 		// Metadata.xml XPath method reference: path="/api/package[@name='xamarin.test']/class[@name='CSharpKeywords']/method[@name='usePartial' and count(parameter)=1 and parameter[1][@type='int']]"

tests/generator-Tests/expected.ji/Constructors/Xamarin.Test.SomeObject.cs

@@ -25,8 +25,12 @@ public partial class SomeObject : global::Java.Lang.Object {
 			get { return _members; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnSomeObjectCreated ();
+
 		protected SomeObject (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 		{
+			_OnSomeObjectCreated ();
 		}
 
 		// Metadata.xml XPath constructor reference: path="/api/package[@name='xamarin.test']/class[@name='SomeObject']/constructor[@name='SomeObject' and count(parameter)=0]"

tests/generator-Tests/expected.ji/Constructors/Xamarin.Test.SomeObject2.cs

@@ -25,8 +25,12 @@ public sealed partial class SomeObject2 : global::Java.Lang.Object {
 			get { return _members; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnSomeObject2Created ();
+
 		internal SomeObject2 (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 		{
+			_OnSomeObject2Created ();
 		}
 
 		// Metadata.xml XPath constructor reference: path="/api/package[@name='xamarin.test']/class[@name='SomeObject2']/constructor[@name='SomeObject2' and count(parameter)=1 and parameter[1][@type='int']]"

tests/generator-Tests/expected.ji/Core_ClassParse/Java.Lang.String.cs

@@ -25,8 +25,12 @@ public partial class String : global::Java.Lang.Object {
 			get { return _members; }
 		}
 
+		/// <summary>Extension point; called when creating a Managed Peer around a preexisting Java Peer instance.</summary>
+		partial void _OnStringCreated ();
+
 		protected String (ref JniObjectReference reference, JniObjectReferenceOptions options) : base (ref reference, options)
 		{
+			_OnStringCreated ();
 		}
 
 	}