[generator] Refactor logic for applying [Obsolete] attributes (#1024)

Context: dotnet/android#7234
Refactor logic for applying `[Obsolete]` attributes into a single
common method. This method will later be extended to add support for
[`[ObsoletedOSPlatformAttribute]`][0].
Doing this piece first and separately allows us to verify that the
refactor does not break anything, as the existing logic is tricky.
A future PR will also remove the temporary hacks used to preserve
stylistic compatibility with a `generator` refactor in 6bbb00a.
[0]: dotnet/runtime#72970

Author: jpobst

tools/generator/SourceWriters/BoundClass.cs

@@ -44,8 +44,7 @@ public BoundClass (ClassGen klass, CodeGenerationOptions opt, CodeGeneratorConte
 klass.JavadocInfo?.AddJavadocs(Comments);
 Comments.Add($"// Metadata.xml XPath class reference: path=\"{klass.MetadataXPathReference}\"");
 
-if(klass.IsDeprecated)
-Attributes.Add(newObsoleteAttr(klass.DeprecatedComment){WriteAttributeSuffix=true});
+SourceWriterExtensions.AddObsolete(Attributes,klass.DeprecatedComment,klass.IsDeprecated,writeAttributeSuffix:true);
 
 SourceWriterExtensions.AddSupportedOSPlatform(Attributes,klass,opt);
 

tools/generator/SourceWriters/BoundConstructor.cs

@@ -33,8 +33,7 @@ public BoundConstructor (ClassGen klass, Ctor constructor, bool useBase, CodeGen
 Attributes.Add(newRegisterAttr(".ctor",constructor.JniSignature,string.Empty,additionalProperties:constructor.AdditionalAttributeString()));
 }
 
-if(constructor.Deprecated!=null)
-Attributes.Add(newObsoleteAttr(constructor.Deprecated.Replace("\"","\"\"")));
+SourceWriterExtensions.AddObsolete(Attributes,constructor.Deprecated);
 
 if(constructor.CustomAttributes!=null)
 Attributes.Add(newCustomAttr(constructor.CustomAttributes));

tools/generator/SourceWriters/BoundField.cs

@@ -30,8 +30,9 @@ public BoundField (GenBase type, Field field, CodeGenerationOptions opt)
 
 if(field.IsEnumified)
 Attributes.Add(newGeneratedEnumAttr());
-if(field.IsDeprecated)
-Attributes.Add(newObsoleteAttr(field.DeprecatedComment,field.IsDeprecatedError){NoAtSign=true,WriteEmptyString=true});
+
+SourceWriterExtensions.AddObsolete(Attributes,field.DeprecatedComment,field.IsDeprecated,noAtSign:true,writeEmptyString:true,isError:field.IsDeprecatedError);
+
 if(field.Annotation.HasValue())
 Attributes.Add(newCustomAttr(field.Annotation));
 

tools/generator/SourceWriters/BoundFieldAsProperty.cs

@@ -47,8 +47,7 @@ public BoundFieldAsProperty (GenBase type, Field field, CodeGenerationOptions op
 Attributes.Add(newRegisterAttr(field.JavaName,additionalProperties:field.AdditionalAttributeString()));
 }
 
-if(field.IsDeprecated)
-Attributes.Add(newObsoleteAttr(field.DeprecatedComment,field.IsDeprecatedError){NoAtSign=true});
+SourceWriterExtensions.AddObsolete(Attributes,field.DeprecatedComment,field.IsDeprecated,noAtSign:true,isError:field.IsDeprecatedError);
 
 SetVisibility(field.Visibility);
 UseExplicitPrivateKeyword=true;

tools/generator/SourceWriters/BoundInterface.cs

@@ -43,8 +43,7 @@ public BoundInterface (InterfaceGen iface, CodeGenerationOptions opt, CodeGenera
 iface.JavadocInfo?.AddJavadocs(Comments);
 Comments.Add($"// Metadata.xml XPath interface reference: path=\"{iface.MetadataXPathReference}\"");
 
-if(iface.IsDeprecated)
-Attributes.Add(newObsoleteAttr(iface.DeprecatedComment){WriteAttributeSuffix=true,WriteEmptyString=true});
+SourceWriterExtensions.AddObsolete(Attributes,iface.DeprecatedComment,iface.IsDeprecated,writeAttributeSuffix:true,writeEmptyString:true);
 
 if(!iface.IsConstSugar(opt)){
 varsignature=string.IsNullOrWhiteSpace(iface.Namespace)

tools/generator/SourceWriters/BoundInterfaceMethodDeclaration.cs

@@ -33,8 +33,9 @@ public BoundInterfaceMethodDeclaration (Method method, string adapter, CodeGener
 
 if(method.DeclaringType.IsGeneratable)
 Comments.Add($"// Metadata.xml XPath method reference: path=\"{method.GetMetadataXPathReference(method.DeclaringType)}\"");
-if(method.Deprecated!=null)
-Attributes.Add(newObsoleteAttr(method.Deprecated.Replace("\"","\"\"")));
+
+SourceWriterExtensions.AddObsolete(Attributes,method.Deprecated);
+
 if(method.IsReturnEnumified)
 Attributes.Add(newGeneratedEnumAttr(true));
 if(method.IsInterfaceDefaultMethod)

tools/generator/SourceWriters/BoundMethod.cs

@@ -74,8 +74,7 @@ public BoundMethod (GenBase type, Method method, CodeGenerationOptions opt, bool
 if(method.DeclaringType.IsGeneratable)
 Comments.Add($"// Metadata.xml XPath method reference: path=\"{method.GetMetadataXPathReference(method.DeclaringType)}\"");
 
-if(method.Deprecated.HasValue())
-Attributes.Add(newObsoleteAttr(method.Deprecated.Replace("\"","\"\"")));
+SourceWriterExtensions.AddObsolete(Attributes,method.Deprecated);
 
 if(method.IsReturnEnumified)
 Attributes.Add(newGeneratedEnumAttr(true));

tools/generator/SourceWriters/BoundMethodAbstractDeclaration.cs

@@ -53,8 +53,7 @@ public BoundMethodAbstractDeclaration (GenBase gen, Method method, CodeGeneratio
 if(method.DeclaringType.IsGeneratable)
 Comments.Add($"// Metadata.xml XPath method reference: path=\"{method.GetMetadataXPathReference(method.DeclaringType)}\"");
 
-if(method.Deprecated.HasValue())
-Attributes.Add(newObsoleteAttr(method.Deprecated.Replace("\"","\"\"")));
+SourceWriterExtensions.AddObsolete(Attributes,method.Deprecated);
 
 SourceWriterExtensions.AddSupportedOSPlatform(Attributes,method,opt);
 

tools/generator/SourceWriters/BoundMethodExtensionStringOverload.cs

@@ -26,8 +26,7 @@ public BoundMethodExtensionStringOverload (Method method, CodeGenerationOptions
 SetVisibility(method.Visibility);
 ReturnType=newTypeReferenceWriter(opt.GetTypeReferenceName(method.RetVal).Replace("Java.Lang.ICharSequence","string").Replace("global::string","string"));
 
-if(method.Deprecated!=null)
-Attributes.Add(newObsoleteAttr(method.Deprecated.Replace("\"","\"\"").Trim()));
+SourceWriterExtensions.AddObsolete(Attributes,method.Deprecated);
 
 SourceWriterExtensions.AddSupportedOSPlatform(Attributes,method,opt);
 

tools/generator/SourceWriters/BoundMethodStringOverload.cs

@@ -24,8 +24,7 @@ public BoundMethodStringOverload (Method method, CodeGenerationOptions opt)
 SetVisibility(method.Visibility);
 ReturnType=newTypeReferenceWriter(opt.GetTypeReferenceName(method.RetVal).Replace("Java.Lang.ICharSequence","string").Replace("global::string","string"));
 
-if(method.Deprecated!=null)
-Attributes.Add(newObsoleteAttr(method.Deprecated.Replace("\"","\"\"").Trim()));
+SourceWriterExtensions.AddObsolete(Attributes,method.Deprecated);
 
 SourceWriterExtensions.AddSupportedOSPlatform(Attributes,method,opt);