Skip to content
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

[bgen] Generate Obsolete + EditorBrowsable attributes in a few more cases. #21135

Merged
merged 3 commits into from
Aug 30, 2024
Merged

[bgen] Generate Obsolete + EditorBrowsable attributes in a few more cases. #21135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea30774
[bgen] Generate Obsolete + EditorBrowsable attributes in a few more c…
rolfbjarne Aug 27, 2024
cb7335b
Auto-format source code
Aug 27, 2024
f3ab8e6
Make introspection happy.
rolfbjarne Aug 28, 2024
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
6 changes: 3 additions & 3 deletions src/avfoundation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ enum AVMediaTypes {
}

#if !NET
[Obsolete ("Use AVMediaTypes enum values")]
[Obsolete ("Use AVMediaTypes enum values.")]
[NoWatch]
[BaseType (typeof (NSObject))]
[Static]
Expand Down Expand Up @@ -420,7 +420,7 @@ enum AVMediaCharacteristics {

#if !NET
[NoWatch]
[Obsolete ("Use AVMediaCharacteristics enum values")]
[Obsolete ("Use AVMediaCharacteristics enum values.")]
[BaseType (typeof (NSObject))]
[Static]
interface AVMediaCharacteristic {
Expand Down Expand Up @@ -598,7 +598,7 @@ enum AVFileTypes {
[NoWatch]
[BaseType (typeof (NSObject))]
[Static]
[Obsolete ("Use AVFileTypes enum values")]
[Obsolete ("Use AVFileTypes enum values.")]
interface AVFileType {
[Field ("AVFileTypeQuickTimeMovie")]
NSString QuickTimeMovie { get; }
Expand Down
1 change: 0 additions & 1 deletion src/bgen/Enums.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ void GenerateEnum (Type type)
sb.Append ("]");
print (sb.ToString ());
}
PrintObsoleteAttributes (type);
CopyNativeName (type);

var unique_constants = new HashSet<string> ();
Expand Down
51 changes: 36 additions & 15 deletions src/bgen/Generator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3866,18 +3866,47 @@ bool DoesPropertyNeedDirtyCheck (PropertyInfo pi, ExportAttribute ea)
}
}

void PrintObsoleteAttributes (ICustomAttributeProvider provider, bool already_has_editor_browsable_attribute = false)
void PrintObsoleteAttributes (ICustomAttributeProvider provider)
{
var obsoleteAttributes = AttributeManager.GetCustomAttributes<ObsoleteAttribute> (provider);

foreach (var oa in obsoleteAttributes) {
print ("[Obsolete (\"{0}\", {1})]", oa.Message, oa.IsError ? "true" : "false");
}

if (!already_has_editor_browsable_attribute && obsoleteAttributes.Any ())
var printEditorBrowsableAttribute = TryGetPrintEditorBrowsableAttribute (provider, out var editorBrowsableAttribute);
if (!printEditorBrowsableAttribute && obsoleteAttributes.Any ()) {
printEditorBrowsableAttribute = true;
editorBrowsableAttribute = "[EditorBrowsable (EditorBrowsableState.Never)]";
}
if (printEditorBrowsableAttribute)
print ("[EditorBrowsable (EditorBrowsableState.Never)]");
}

bool TryGetPrintEditorBrowsableAttribute (ICustomAttributeProvider provider, out string attribute)
{
attribute = string.Empty;
foreach (var ea in AttributeManager.GetCustomAttributes<EditorBrowsableAttribute> (provider)) {
switch (ea.State) {
case EditorBrowsableState.Always:
attribute = "[EditorBrowsable (EditorBrowsableState.Always)]";
break;
case EditorBrowsableState.Never:
attribute = "[EditorBrowsable (EditorBrowsableState.Never)]";
break;
case EditorBrowsableState.Advanced:
attribute = "[EditorBrowsable (EditorBrowsableState.Advanced)]";
break;
default:
attribute = $"[EditorBrowsable (EditorBrowsableState.{ea.State})]";
break;
}
return true;
}

return false;
}

void PrintPropertyAttributes (PropertyInfo pi, Type type, bool skipTypeInjection = false)
{
var minfo = new MemberInformation (this, this, pi, type);
Expand Down Expand Up @@ -4418,21 +4447,11 @@ void GenerateAsyncMethod (MemberInformation original_minfo, AsyncMethodKind asyn
void PrintMethodAttributes (MemberInformation minfo)
{
MethodInfo mi = minfo.Method;
var editor_browsable_attribute = false;

foreach (var sa in AttributeManager.GetCustomAttributes<ThreadSafeAttribute> (mi))
print (sa.Safe ? "[ThreadSafe]" : "[ThreadSafe (false)]");

foreach (var ea in AttributeManager.GetCustomAttributes<EditorBrowsableAttribute> (mi)) {
if (ea.State == EditorBrowsableState.Always) {
print ("[EditorBrowsable]");
} else {
print ("[EditorBrowsable (EditorBrowsableState.{0})]", ea.State);
}
editor_browsable_attribute = true;
}

PrintObsoleteAttributes (mi, editor_browsable_attribute);
PrintObsoleteAttributes (mi);

if (minfo.is_return_release)
print ("[return: ReleaseAttribute ()]");
Expand Down Expand Up @@ -5507,7 +5526,7 @@ public void PrintBindAsAttribute (ICustomAttributeProvider mi, StringBuilder sb
// Not adding the experimental attribute is bad (it would mean that an API
// we meant to be experimental ended up being released as stable), so it's
// opt-out instead of opt-in.
public void PrintAttributes (ICustomAttributeProvider mi, bool platform = false, bool preserve = false, bool advice = false, bool notImplemented = false, bool bindAs = false, bool requiresSuper = false, Type inlinedType = null, bool experimental = true)
public void PrintAttributes (ICustomAttributeProvider mi, bool platform = false, bool preserve = false, bool advice = false, bool notImplemented = false, bool bindAs = false, bool requiresSuper = false, Type inlinedType = null, bool experimental = true, bool obsolete = false)
{
if (platform)
PrintPlatformAttributes (mi as MemberInfo, inlinedType);
Expand All @@ -5523,6 +5542,8 @@ public void PrintAttributes (ICustomAttributeProvider mi, bool platform = false,
PrintRequiresSuperAttribute (mi);
if (experimental)
PrintExperimentalAttribute (mi);
if (obsolete)
PrintObsoleteAttributes (mi);
}

public void PrintExperimentalAttribute (ICustomAttributeProvider mi)
Expand Down Expand Up @@ -5754,7 +5775,7 @@ public void Generate (Type type)
print ("[Model]");
}

PrintAttributes (type, platform: true, preserve: true, advice: true);
PrintAttributes (type, platform: true, preserve: true, advice: true, obsolete: true);

if (type.IsEnum) {
GenerateEnum (type);
Expand Down
Loading
Loading