Skip to content

[generator] Remove [Obsolete] style compatibility hacks. #1025

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
merged 1 commit into from
Aug 12, 2022
Merged

[generator] Remove [Obsolete] style compatibility hacks. #1025

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
2 changes: 1 addition & 1 deletion ...rator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1-NRT/WriteInterface.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public abstract class MyInterface : Java.Lang.Object {
}

[Register ("java/code/IMyInterface", DoNotGenerateAcw=true)]
[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
[global::System.Obsolete (@"Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
public abstract class MyInterfaceConsts : MyInterface {
private MyInterfaceConsts ()
{
Expand Down
16 changes: 8 additions & 8 deletions ...t-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/ObsoleteInterfaceAlternativeClass.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
[Register ("com/xamarin/android/Parent", DoNotGenerateAcw=true)]
[global::System.Obsolete ("Use the 'Com.Xamarin.Android.IParent' type. This class will be removed in a future release.")]
[global::System.Obsolete (@"Use the 'Com.Xamarin.Android.IParent' type. This class will be removed in a future release.")]
public abstract class Parent : Java.Lang.Object {
internal Parent ()
{
}

// Metadata.xml XPath field reference: path="/api/package[@name='com.xamarin.android']/interface[@name='Parent']/field[@name='ACCEPT_HANDOVER']"
[Register ("ACCEPT_HANDOVER")]
[Obsolete ("Use 'Com.Xamarin.Android.IParent.AcceptHandover'. This class will be removed in a future release.")]
[global::System.Obsolete (@"Use 'Com.Xamarin.Android.IParent.AcceptHandover'. This class will be removed in a future release.")]
public const string AcceptHandover = (string) "android.permission.ACCEPT_HANDOVER";

// Metadata.xml XPath field reference: path="/api/package[@name='com.xamarin.android']/interface[@name='Parent']/field[@name='ALREADY_OBSOLETE']"
[Register ("ALREADY_OBSOLETE")]
[Obsolete ("deprecated")]
[global::System.Obsolete (@"deprecated")]
public const string AlreadyObsolete = (string) "android.permission.ACCEPT_HANDOVER";


// Metadata.xml XPath field reference: path="/api/package[@name='com.xamarin.android']/interface[@name='Parent']/field[@name='API_NAME']"
[Register ("API_NAME")]
[Obsolete ("Use 'Com.Xamarin.Android.IParent.ApiName'. This class will be removed in a future release.")]
[global::System.Obsolete (@"Use 'Com.Xamarin.Android.IParent.ApiName'. This class will be removed in a future release.")]
public static string ApiName {
get {
const string __id = "API_NAME.Ljava/lang/String;";
Expand All @@ -29,7 +29,7 @@ public abstract class Parent : Java.Lang.Object {
}

// Metadata.xml XPath method reference: path="/api/package[@name='com.xamarin.android']/interface[@name='Parent']/method[@name='comparing' and count(parameter)=0]"
[Obsolete (@"Use 'Com.Xamarin.Android.IParent.Comparing'. This class will be removed in a future release.")]
[global::System.Obsolete (@"Use 'Com.Xamarin.Android.IParent.Comparing'. This class will be removed in a future release.")]
[Register ("comparing", "()I", "")]
public static unsafe int Comparing ()
{
Expand All @@ -42,7 +42,7 @@ public abstract class Parent : Java.Lang.Object {
}

// Metadata.xml XPath method reference: path="/api/package[@name='com.xamarin.android']/interface[@name='Parent']/method[@name='comparingOld' and count(parameter)=0]"
[Obsolete (@"deprecated")]
[global::System.Obsolete (@"deprecated")]
[Register ("comparingOld", "()I", "")]
public static unsafe int ComparingOld ()
{
Expand All @@ -69,7 +69,7 @@ public partial interface IParent : IJavaObject, IJavaPeerable {

// Metadata.xml XPath field reference: path="/api/package[@name='com.xamarin.android']/interface[@name='Parent']/field[@name='ALREADY_OBSOLETE']"
[Register ("ALREADY_OBSOLETE")]
[Obsolete ("deprecated")]
[global::System.Obsolete (@"deprecated")]
public const string AlreadyObsolete = (string) "android.permission.ACCEPT_HANDOVER";


Expand Down Expand Up @@ -97,7 +97,7 @@ public partial interface IParent : IJavaObject, IJavaPeerable {
}

// Metadata.xml XPath method reference: path="/api/package[@name='com.xamarin.android']/interface[@name='Parent']/method[@name='comparingOld' and count(parameter)=0]"
[Obsolete (@"deprecated")]
[global::System.Obsolete (@"deprecated")]
[Register ("comparingOld", "()I", "")]
public static unsafe int ComparingOld ()
{
Expand Down
2 changes: 1 addition & 1 deletion ...generator-Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteInterface.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public abstract class MyInterface : Java.Lang.Object {
}

[Register ("java/code/IMyInterface", DoNotGenerateAcw=true)]
[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
[global::System.Obsolete (@"Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
public abstract class MyInterfaceConsts : MyInterface {
private MyInterfaceConsts ()
{
Expand Down
2 changes: 1 addition & 1 deletion ...it-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteInterfaceFieldAsDimProperty.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public abstract class MyInterface : Java.Lang.Object {
}

[Register ("com/xamarin/android/MyInterface", DoNotGenerateAcw=true)]
[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
[global::System.Obsolete (@"Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
public abstract class MyInterfaceConsts : MyInterface {
private MyInterfaceConsts ()
{
Expand Down
2 changes: 1 addition & 1 deletion ...sts/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteStaticInterfaceMethod.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public abstract class MyInterface : Java.Lang.Object {
}

[Register ("java/code/IMyInterface", DoNotGenerateAcw=true)]
[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
[global::System.Obsolete (@"Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
public abstract class MyInterfaceConsts : MyInterface {
private MyInterfaceConsts ()
{
Expand Down
2 changes: 1 addition & 1 deletion tests/generator-Tests/Unit-Tests/CodeGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@ public void ObsoleteBoundMethodAbstractDeclaration ()
generator.Context.ContextTypes.Pop ();

// Ensure [Obsolete] was written
Assert.True (writer.ToString ().Contains ("[Obsolete (@\"This is so old!\")]"), writer.ToString ());
Assert.True (writer.ToString ().Contains ("[global::System.Obsolete (@\"This is so old!\")]"), writer.ToString ());
}

[Test]
Expand Down
2 changes: 1 addition & 1 deletion tests/generator-Tests/expected.ji/Constructors/Xamarin.Test.SomeObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ protected SomeObject (ref JniObjectReference reference, JniObjectReferenceOption
}

// Metadata.xml XPath constructor reference: path="/api/package[@name='xamarin.test']/class[@name='SomeObject']/constructor[@name='SomeObject' and count(parameter)=0]"
[Obsolete (@"deprecated")]
[global::System.Obsolete (@"deprecated")]
public unsafe SomeObject () : base (ref *InvalidJniObjectReference, JniObjectReferenceOptions.None)
{
const string __id = "()V";
Expand Down
2 changes: 1 addition & 1 deletion tests/generator-Tests/expected.ji/NormalMethods/Xamarin.Test.SomeObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public virtual unsafe void VoidMethodWithParams (string astring, int anint, glob
}

// Metadata.xml XPath method reference: path="/api/package[@name='xamarin.test']/class[@name='SomeObject']/method[@name='ObsoleteMethod' and count(parameter)=0]"
[Obsolete (@"Deprecated please use IntegerMethod instead")]
[global::System.Obsolete (@"Deprecated please use IntegerMethod instead")]
public virtual unsafe int ObsoleteMethod ()
{
const string __id = "ObsoleteMethod.()I";
Expand Down
2 changes: 1 addition & 1 deletion tests/generator-Tests/expected.ji/StaticMethods/Xamarin.Test.SomeObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public static unsafe string MethodAsString ()
}

// Metadata.xml XPath method reference: path="/api/package[@name='xamarin.test']/class[@name='SomeObject']/method[@name='Obsoletemethod' and count(parameter)=0]"
[Obsolete (@"Deprecated please use methodAsString")]
[global::System.Obsolete (@"Deprecated please use methodAsString")]
[global::Java.Interop.JniMethodSignature ("Obsoletemethod", "()Ljava/lang/String;")]
public static unsafe string Obsoletemethod ()
{
Expand Down
2 changes: 1 addition & 1 deletion tests/generator-Tests/expected.xaji/Constructors/Xamarin.Test.SomeObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ protected SomeObject (IntPtr javaReference, JniHandleOwnership transfer) : base

// Metadata.xml XPath constructor reference: path="/api/package[@name='xamarin.test']/class[@name='SomeObject']/constructor[@name='SomeObject' and count(parameter)=0]"
[Register (".ctor", "()V", "")]
[Obsolete (@"deprecated")]
[global::System.Obsolete (@"deprecated")]
public unsafe SomeObject () : base (IntPtr.Zero, JniHandleOwnership.DoNotTransfer)
{
const string __id = "()V";
Expand Down
6 changes: 3 additions & 3 deletions tests/generator-Tests/expected.xaji/NormalMethods/Xamarin.Test.SomeObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,15 +269,15 @@ public virtual unsafe void VoidMethodWithParams (string astring, int anint, glob

static Delegate cb_ObsoleteMethod;
#pragma warning disable 0169
[Obsolete]
[global::System.Obsolete]
static Delegate GetObsoleteMethodHandler ()
{
if (cb_ObsoleteMethod == null)
cb_ObsoleteMethod = JNINativeWrapper.CreateDelegate ((_JniMarshal_PP_I) n_ObsoleteMethod);
return cb_ObsoleteMethod;
}

[Obsolete]
[global::System.Obsolete]
static int n_ObsoleteMethod (IntPtr jnienv, IntPtr native__this)
{
var __this = global::Java.Lang.Object.GetObject<global::Xamarin.Test.SomeObject> (jnienv, native__this, JniHandleOwnership.DoNotTransfer);
Expand All @@ -286,7 +286,7 @@ static int n_ObsoleteMethod (IntPtr jnienv, IntPtr native__this)
#pragma warning restore 0169

// Metadata.xml XPath method reference: path="/api/package[@name='xamarin.test']/class[@name='SomeObject']/method[@name='ObsoleteMethod' and count(parameter)=0]"
[Obsolete (@"Deprecated please use IntegerMethod instead")]
[global::System.Obsolete (@"Deprecated please use IntegerMethod instead")]
[Register ("ObsoleteMethod", "()I", "GetObsoleteMethodHandler")]
public virtual unsafe int ObsoleteMethod ()
{
Expand Down
2 changes: 1 addition & 1 deletion tests/generator-Tests/expected.xaji/StaticMethods/Xamarin.Test.SomeObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public static unsafe string MethodAsString ()
}

// Metadata.xml XPath method reference: path="/api/package[@name='xamarin.test']/class[@name='SomeObject']/method[@name='Obsoletemethod' and count(parameter)=0]"
[Obsolete (@"Deprecated please use methodAsString")]
[global::System.Obsolete (@"Deprecated please use methodAsString")]
[Register ("Obsoletemethod", "()Ljava/lang/String;", "")]
public static unsafe string Obsoletemethod ()
{
Expand Down
2 changes: 1 addition & 1 deletion tests/generator-Tests/expected.xaji/TestInterface/Test.ME.ITestInterface.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ internal TestInterface ()
}

[Register ("test/me/TestInterface", DoNotGenerateAcw=true)]
[global::System.Obsolete ("Use the 'TestInterface' type. This type will be removed in a future release.", error: true)]
[global::System.Obsolete (@"Use the 'TestInterface' type. This type will be removed in a future release.", error: true)]
public abstract class TestInterfaceConsts : TestInterface {
private TestInterfaceConsts ()
{
Expand Down
26 changes: 10 additions & 16 deletions tools/generator/SourceWriters/Attributes/ObsoleteAttr.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ public class ObsoleteAttr : AttributeWriter
{
public string Message { get; set; }
public bool IsError { get; set; }
public bool NoAtSign { get; set; } // TODO: Temporary to match unit tests
public bool WriteEmptyString { get; set; } // TODO: Temporary to match unit tests
public bool WriteAttributeSuffix { get; set; } // TODO: Temporary to match unit tests
public bool WriteGlobal { get; set; } // TODO: Temporary to match unit tests

public ObsoleteAttr (string message = null, bool isError = false)
{
Expand All @@ -24,22 +20,20 @@ public ObsoleteAttr (string message = null, bool isError = false)

public override void WriteAttribute (CodeWriter writer)
{
var attr_name = WriteAttributeSuffix ? "ObsoleteAttribute" : "Obsolete";
var parts = new List<string> ();

if (WriteGlobal)
attr_name = "global::System." + attr_name;

if (Message is null && !WriteEmptyString && !IsError) {
writer.WriteLine ($"[{attr_name}]");
return;
}

writer.Write ($"[{attr_name} ({(NoAtSign ? "" : "@")}\"{Message}\"");
if (Message != null)
parts.Add ($"@\"{Message}\"");

if (IsError)
writer.Write (", error: true");
parts.Add ("error: true");

var content = string.Join (", ", parts.ToArray ());

writer.WriteLine (")]");
if (content.HasValue ())
writer.WriteLine ($"[global::System.Obsolete ({content})]");
Copy link
Contributor

@jonpryor jonpryor Aug 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A concern with this approach is that it could result in invalid code: if Message is null and IsError is true, then we would attempt to emit [Obsolete(error:true)], which will fail to compile as there is no Obsolete(bool) constructor.

Is it possible for Message to be null and IsError to be true?

One one level, "no", because @deprecated is "never" null.

Except when we only pass null:

% git grep 'SourceWriterExtensions.AddObsolete.*null'    
tools/generator/SourceWriters/MethodCallback.cs:                        SourceWriterExtensions.AddObsolete (Attributes, null, forceDeprecate: !string.IsNullOrWhiteSpace (method.Deprecated));
tools/generator/SourceWriters/MethodCallback.cs:                        SourceWriterExtensions.AddObsolete (Attributes, null, forceDeprecate: !string.IsNullOrWhiteSpace (method.Deprecated))

These callsites don't use isError:true, so we should be fine.

else
writer.WriteLine ("[global::System.Obsolete]");
}
}
}
2 changes: 1 addition & 1 deletion tools/generator/SourceWriters/BoundClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public BoundClass (ClassGen klass, CodeGenerationOptions opt, CodeGeneratorConte
klass.JavadocInfo?.AddJavadocs (Comments);
Comments.Add ($"// Metadata.xml XPath class reference: path=\"{klass.MetadataXPathReference}\"");

SourceWriterExtensions.AddObsolete (Attributes, klass.DeprecatedComment, klass.IsDeprecated, writeAttributeSuffix: true);
SourceWriterExtensions.AddObsolete (Attributes, klass.DeprecatedComment, klass.IsDeprecated);

SourceWriterExtensions.AddSupportedOSPlatform (Attributes, klass, opt);

Expand Down
2 changes: 1 addition & 1 deletion tools/generator/SourceWriters/BoundField.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public BoundField (GenBase type, Field field, CodeGenerationOptions opt)
if (field.IsEnumified)
Attributes.Add (new GeneratedEnumAttr ());

SourceWriterExtensions.AddObsolete (Attributes, field.DeprecatedComment, field.IsDeprecated, noAtSign: true, writeEmptyString: true, isError: field.IsDeprecatedError);
SourceWriterExtensions.AddObsolete (Attributes, field.DeprecatedComment, field.IsDeprecated, isError: field.IsDeprecatedError);

if (field.Annotation.HasValue ())
Attributes.Add (new CustomAttr (field.Annotation));
Expand Down
2 changes: 1 addition & 1 deletion tools/generator/SourceWriters/BoundFieldAsProperty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public BoundFieldAsProperty (GenBase type, Field field, CodeGenerationOptions op
Attributes.Add (new RegisterAttr (field.JavaName, additionalProperties: field.AdditionalAttributeString ()));
}

SourceWriterExtensions.AddObsolete (Attributes, field.DeprecatedComment, field.IsDeprecated, noAtSign: true, isError: field.IsDeprecatedError);
SourceWriterExtensions.AddObsolete (Attributes, field.DeprecatedComment, field.IsDeprecated, isError: field.IsDeprecatedError);

SetVisibility (field.Visibility);
UseExplicitPrivateKeyword = true;
Expand Down
2 changes: 1 addition & 1 deletion tools/generator/SourceWriters/BoundInterface.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public BoundInterface (InterfaceGen iface, CodeGenerationOptions opt, CodeGenera
iface.JavadocInfo?.AddJavadocs (Comments);
Comments.Add ($"// Metadata.xml XPath interface reference: path=\"{iface.MetadataXPathReference}\"");

SourceWriterExtensions.AddObsolete (Attributes, iface.DeprecatedComment, iface.IsDeprecated, writeAttributeSuffix: true, writeEmptyString: true);
SourceWriterExtensions.AddObsolete (Attributes, iface.DeprecatedComment, iface.IsDeprecated);

if (!iface.IsConstSugar (opt)) {
var signature = string.IsNullOrWhiteSpace (iface.Namespace)
Expand Down
9 changes: 2 additions & 7 deletions tools/generator/SourceWriters/Extensions/SourceWriterExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,18 +301,13 @@ public static void AddSupportedOSPlatform (List<AttributeWriter> attributes, Api

}

public static void AddObsolete (List<AttributeWriter> attributes, string message, bool forceDeprecate = false, bool isError = false, bool noAtSign = false, bool writeEmptyString = false, bool writeAttributeSuffix = false, bool writeGlobal = false)
public static void AddObsolete (List<AttributeWriter> attributes, string message, bool forceDeprecate = false, bool isError = false)
{
// Bail if we're not obsolete
if ((!forceDeprecate && !message.HasValue ()) || message == "not deprecated")
return;

attributes.Add (new ObsoleteAttr (message: message?.Replace ("\"", "\"\"").Trim (), isError: isError) {
NoAtSign = noAtSign,
WriteAttributeSuffix = writeAttributeSuffix,
WriteEmptyString = writeEmptyString,
WriteGlobal = writeGlobal
});
attributes.Add (new ObsoleteAttr (message: message?.Replace ("\"", "\"\"").Trim (), isError: isError));
}

public static void WriteMethodInvokerBody (CodeWriter writer, Method method, CodeGenerationOptions opt, string contextThis)
Expand Down
4 changes: 2 additions & 2 deletions tools/generator/SourceWriters/InterfaceMemberAlternativeClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public InterfaceMemberAlternativeClass (InterfaceGen iface, CodeGenerationOption
Attributes.Add (new RegisterAttr (iface.RawJniName, noAcw: true, additionalProperties: iface.AdditionalAttributeString ()) { AcwLast = true });

if (should_obsolete)
Attributes.Add (new ObsoleteAttr ($"Use the '{iface.FullName}' type. This class will be removed in a future release.") { WriteGlobal = true, NoAtSign = true });
SourceWriterExtensions.AddObsolete (Attributes, $"Use the '{iface.FullName}' type. This class will be removed in a future release.");

Constructors.Add (new ConstructorWriter { Name = Name, IsInternal = true });

Expand Down Expand Up @@ -180,7 +180,7 @@ public InterfaceConstsForwardClass (InterfaceGen iface)
IsAbstract = true;

Attributes.Add (new RegisterAttr (iface.RawJniName, noAcw: true, additionalProperties: iface.AdditionalAttributeString ()));
Attributes.Add (new ObsoleteAttr ($"Use the '{iface.Name.Substring (1)}' type. This type will be removed in a future release.", true) { NoAtSign = true, WriteGlobal = true });
SourceWriterExtensions.AddObsolete (Attributes, $"Use the '{iface.Name.Substring (1)}' type. This type will be removed in a future release.", isError: true);

Constructors.Add (new ConstructorWriter {
Name = Name,
Expand Down