Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[generator] Add managedOverride values none and reabstract. #1000

Merged
merged 1 commit into from
Jul 7, 2022
Merged

[generator] Add managedOverride values none and reabstract. #1000

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
100 changes: 100 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 @@ -147,6 +147,56 @@ public void ManagedOverrideMethod_Override ()
Assert.True (writer.ToString ().Contains ("public override unsafe int DoStuff ()"), $"was: `{writer.ToString ()}`");
}

[Test]
public void ManagedOverrideMethod_None ()
{
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='com.xamarin.android' jni-name='com/xamarin/android'>
<class abstract='false' deprecated='not deprecated' extends='java.lang.Object' extends-generic-aware='java.lang.Object' jni-extends='Ljava/lang/Object;' final='false' name='MyClass' static='false' visibility='public' jni-signature='Lcom/xamarin/android/MyClass;'>
<method abstract='false' deprecated='not deprecated' final='false' name='DoStuff' jni-signature='()I' bridge='false' native='false' return='int' jni-return='I' static='false' synchronized='false' synthetic='false' visibility='public' managedOverride='none'></method>
</class>
</package>
</api>";

var gens = ParseApiDefinition (xml);
var klass = gens.Single (g => g.Name == "MyClass");

generator.Context.ContextTypes.Push (klass);
generator.WriteType (klass, string.Empty, new GenerationInfo ("", "", "MyAssembly"));
generator.Context.ContextTypes.Pop ();

// This would contain 'virtual' if the 'managedOverride' was not working
Assert.True (writer.ToString ().Contains ("public unsafe int DoStuff ()"), $"was: `{writer}`");
}

[Test]
public void ManagedOverrideInterfaceMethod_Reabstract ()
{
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='com.xamarin.android' jni-name='com/xamarin/android'>
<interface abstract='false' deprecated='not deprecated' extends='java.lang.Object' extends-generic-aware='java.lang.Object' jni-extends='Ljava/lang/Object;' final='false' name='MyInterface' static='false' visibility='public' jni-signature='Lcom/xamarin/android/MyInterface;'>
<method abstract='true' deprecated='not deprecated' final='false' name='DoStuff' jni-signature='()I' bridge='false' native='false' return='int' jni-return='I' static='false' synchronized='false' synthetic='false' visibility='public' managedOverride='reabstract'></method>
</interface>
</package>
</api>";

var gens = ParseApiDefinition (xml);
var iface = gens.Single (g => g.Name == "IMyInterface");

generator.Context.ContextTypes.Push (iface);
generator.WriteType (iface, string.Empty, new GenerationInfo ("", "", "MyAssembly"));
generator.Context.ContextTypes.Pop ();

// This would not contain 'abstract' if the 'managedOverride' was not working
Assert.True (writer.ToString ().Contains ("abstract int DoStuff ()"), $"was: `{writer}`");
}

[Test]
public void ManagedOverrideProperty_Virtual ()
{
Expand Down Expand Up @@ -195,6 +245,56 @@ public void ManagedOverrideProperty_Override ()
Assert.True (writer.ToString ().Contains ("public override unsafe int Name {"), $"was: `{writer.ToString ()}`");
}

[Test]
public void ManagedOverrideProperty_None ()
{
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='com.xamarin.android' jni-name='com/xamarin/android'>
<class abstract='false' deprecated='not deprecated' extends='java.lang.Object' extends-generic-aware='java.lang.Object' jni-extends='Ljava/lang/Object;' final='false' name='MyClass' static='false' visibility='public' jni-signature='Lcom/xamarin/android/MyClass;'>
<method abstract='false' deprecated='not deprecated' final='false' name='getName' jni-signature='()I' bridge='false' native='false' return='int' jni-return='I' static='false' synchronized='false' synthetic='false' visibility='public' managedOverride='none'></method>
</class>
</package>
</api>";

var gens = ParseApiDefinition (xml);
var klass = gens.Single (g => g.Name == "MyClass");

generator.Context.ContextTypes.Push (klass);
generator.WriteType (klass, string.Empty, new GenerationInfo ("", "", "MyAssembly"));
generator.Context.ContextTypes.Pop ();

// This would contain 'virtual' if the 'managedOverride' was not working
Assert.True (writer.ToString ().Contains ("public unsafe int Name {"), $"was: `{writer}`");
}

[Test]
public void ManagedOverrideInterfaceProperty_Reabstract ()
{
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='com.xamarin.android' jni-name='com/xamarin/android'>
<interface abstract='false' deprecated='not deprecated' extends='java.lang.Object' extends-generic-aware='java.lang.Object' jni-extends='Ljava/lang/Object;' final='false' name='MyInterface' static='false' visibility='public' jni-signature='Lcom/xamarin/android/MyInterface;'>
<method abstract='true' deprecated='not deprecated' final='false' name='getName' jni-signature='()I' bridge='false' native='false' return='int' jni-return='I' static='false' synchronized='false' synthetic='false' visibility='public' managedOverride='reabstract'></method>
</interface>
</package>
</api>";

var gens = ParseApiDefinition (xml);
var iface = gens.Single (g => g.Name == "IMyInterface");

generator.Context.ContextTypes.Push (iface);
generator.WriteType (iface, string.Empty, new GenerationInfo ("", "", "MyAssembly"));
generator.Context.ContextTypes.Pop ();

// This would not contain 'abstract' if the 'managedOverride' was not working
Assert.True (writer.ToString ().Contains ("abstract int Name {"), $"was: `{writer}`");
}

[Test]
public void WriteDuplicateInterfaceEventArgs ()
{
Expand Down
4 changes: 4 additions & 0 deletions tools/generator/SourceWriters/BoundInterfaceMethodDeclaration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ public BoundInterfaceMethodDeclaration (Method method, string adapter, CodeGener
ReturnType = new TypeReferenceWriter (opt.GetTypeReferenceName (method.RetVal));
IsDeclaration = true;

// Allow user to force adding the 'abstract' keyword for "reabstraction"
if (method.ManagedOverride?.ToLowerInvariant () == "reabstract")
IsAbstract = true;

if (method.DeclaringType.IsGeneratable)
Comments.Add ($"// Metadata.xml XPath method reference: path=\"{method.GetMetadataXPathReference (method.DeclaringType)}\"");
if (method.Deprecated != null)
Expand Down
4 changes: 4 additions & 0 deletions tools/generator/SourceWriters/BoundInterfacePropertyDeclaration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ public BoundInterfacePropertyDeclaration (GenBase gen, Property property, string
PropertyType = new TypeReferenceWriter (opt.GetTypeReferenceName (property));
IsAutoProperty = true;

// Allow user to force adding the 'abstract' keyword for "reabstraction"
if ((property.Getter ?? property.Setter).ManagedOverride?.ToLowerInvariant () == "reabstract")
IsAbstract = true;

if (property.Getter != null) {
HasGet = true;

Expand Down
3 changes: 3 additions & 0 deletions tools/generator/SourceWriters/BoundMethod.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ public BoundMethod (GenBase type, Method method, CodeGenerationOptions opt, bool
} else if (method.ManagedOverride?.ToLowerInvariant () == "override") {
IsVirtual = false;
IsOverride = true;
} else if (method.ManagedOverride?.ToLowerInvariant () == "none") {
IsVirtual = false;
IsOverride = false;
}

ReturnType = new TypeReferenceWriter (opt.GetTypeReferenceName (method.RetVal));
Expand Down
3 changes: 3 additions & 0 deletions tools/generator/SourceWriters/BoundProperty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ public BoundProperty (GenBase gen, Property property, CodeGenerationOptions opt,
} else if (!forceOverride && (property.Getter ?? property.Setter).ManagedOverride?.ToLowerInvariant () == "override") {
IsVirtual = false;
IsOverride = true;
} else if (!forceOverride && (property.Getter ?? property.Setter).ManagedOverride?.ToLowerInvariant () == "none") {
IsVirtual = false;
IsOverride = false;
}

// Unlike [Register], [Obsolete] cannot be put on property accessors, so we can apply them only under limited condition...
Expand Down