-
Notifications
You must be signed in to change notification settings - Fork 8
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.
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
Add [MemberNotNull] and [MemberNotNullWhen] support #85
Closed
Closed
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
7998d44
Add [MemberNotNull] and [MemberNotNullWhen] support
kevinchalet 2bd2f90
Seal the MemberNotNullAttribute class and update the NullableAttribut…
kevinchalet 88aa51b
Decorate params array attributes with [ParamArray]
kevinchalet f3dddde
Add [Nullable(0)] and [NullableContext(1)] to match MemberNotNullAttr…
kevinchalet c7338d9
Update the .targets file to include the nullable attributes on more TFMs
kevinchalet d1c6a8f
Remove extra parenthesis
kevinchalet a7ce003
Try a different approach
kevinchalet 9b3aedf
Remove extra quote
kevinchalet 5623152
Try again
kevinchalet 8e967b9
Remove extra parenthesis
kevinchalet File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
TunnelVisionLabs.ReferenceAssemblyAnnotator/NullableAttributes.gen2.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| // <auto-generated /> | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| // This was copied from https://github.com/dotnet/runtime/blob/v5.0.0-rc.1.20451.14/src/libraries/System.Private.CoreLib/src/System/Diagnostics/CodeAnalysis/NullableAttributes.cs | ||
| // and updated to have the scope of the attributes be internal. | ||
|
|
||
| namespace System.Diagnostics.CodeAnalysis | ||
| { | ||
| /// <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary> | ||
| [AttributeUsage(AttributeTargets.Method | AttributeTargets.Property, Inherited = false, AllowMultiple = true)] | ||
| internal sealed class MemberNotNullAttribute : Attribute | ||
| { | ||
| /// <summary>Initializes the attribute with a field or property member.</summary> | ||
| /// <param name="member"> | ||
| /// The field or property member that is promised to be not-null. | ||
| /// </param> | ||
| public MemberNotNullAttribute(string member) => Members = new[] { member }; | ||
|
|
||
| /// <summary>Initializes the attribute with the list of field and property members.</summary> | ||
| /// <param name="members"> | ||
| /// The list of field and property members that are promised to be not-null. | ||
| /// </param> | ||
| public MemberNotNullAttribute(params string[] members) => Members = members; | ||
|
|
||
| /// <summary>Gets field or property member names.</summary> | ||
| public string[] Members { get; } | ||
| } | ||
|
|
||
| /// <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary> | ||
| [AttributeUsage(AttributeTargets.Method | AttributeTargets.Property, Inherited = false, AllowMultiple = true)] | ||
| internal sealed class MemberNotNullWhenAttribute : Attribute | ||
| { | ||
| /// <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary> | ||
| /// <param name="returnValue"> | ||
| /// The return value condition. If the method returns this value, the associated parameter will not be null. | ||
| /// </param> | ||
| /// <param name="member"> | ||
| /// The field or property member that is promised to be not-null. | ||
| /// </param> | ||
| public MemberNotNullWhenAttribute(bool returnValue, string member) | ||
| { | ||
| ReturnValue = returnValue; | ||
| Members = new[] { member }; | ||
| } | ||
|
|
||
| /// <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary> | ||
| /// <param name="returnValue"> | ||
| /// The return value condition. If the method returns this value, the associated parameter will not be null. | ||
| /// </param> | ||
| /// <param name="members"> | ||
| /// The list of field and property members that are promised to be not-null. | ||
| /// </param> | ||
| public MemberNotNullWhenAttribute(bool returnValue, params string[] members) | ||
| { | ||
| ReturnValue = returnValue; | ||
| Members = members; | ||
| } | ||
|
|
||
| /// <summary>Gets the return value condition.</summary> | ||
| public bool ReturnValue { get; } | ||
|
|
||
| /// <summary>Gets field or property member names.</summary> | ||
| public string[] Members { get; } | ||
| } | ||
| } |
75 changes: 75 additions & 0 deletions
75
TunnelVisionLabs.ReferenceAssemblyAnnotator/NullableAttributes.gen2.vb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| ' <auto-generated /> | ||
| ' Licensed to the .NET Foundation under one or more agreements. | ||
| ' The .NET Foundation licenses this file to you under the MIT license. | ||
| ' See the LICENSE file in the project root for more information. | ||
|
|
||
| ' This was copied from https://github.com/dotnet/runtime/blob/v5.0.0-rc.1.20451.14/src/libraries/System.Private.CoreLib/src/System/Diagnostics/CodeAnalysis/NullableAttributes.cs | ||
| ' and updated to have the scope of the attributes be internal. | ||
|
|
||
| Imports System | ||
| Imports System.Diagnostics | ||
|
|
||
| Namespace Global.System.Diagnostics.CodeAnalysis | ||
|
|
||
| ''' <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary> | ||
| <AttributeUsage(AttributeTargets.Method Or AttributeTargets.Property, Inherited:=False, AllowMultiple:=True)> | ||
| Friend NotInheritable Class MemberNotNullAttribute | ||
| Inherits Attribute | ||
|
|
||
| ''' <summary>Initializes the attribute with a field or property member.</summary> | ||
| ''' <param name="member"> | ||
| ''' The field or property member that is promised to be not-null. | ||
| ''' </param> | ||
| Public Sub New(member As String) | ||
| Me.Members = {member} | ||
| End Sub | ||
|
|
||
| ''' <summary>Initializes the attribute with the list of field and property members.</summary> | ||
| ''' <param name="members"> | ||
| ''' The list of field and property members that are promised to be not-null. | ||
| ''' </param> | ||
| Public Sub New(ParamArray members As String()) | ||
| Me.Members = members | ||
| End Sub | ||
|
|
||
| ''' <summary>Gets field or property member names.</summary> | ||
| Public ReadOnly Property Members As String() | ||
| End Class | ||
|
|
||
| ''' <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary> | ||
| <AttributeUsage(AttributeTargets.Method Or AttributeTargets.Property, Inherited:=False, AllowMultiple:=True)> | ||
| Friend NotInheritable Class MemberNotNullWhenAttribute | ||
| Inherits Attribute | ||
|
|
||
| ''' <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary> | ||
| ''' <param name="returnValue"> | ||
| ''' The return value condition. If the method returns this value, the associated parameter will not be null. | ||
| ''' </param> | ||
| ''' <param name="member"> | ||
| ''' The field or property member that is promised to be not-null. | ||
| ''' </param> | ||
| Public Sub New(returnValue As Boolean, member As String) | ||
| Me.ReturnValue = returnValue | ||
| Me.Members = {member} | ||
| End Sub | ||
|
|
||
| ''' <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary> | ||
| ''' <param name="returnValue"> | ||
| ''' The return value condition. If the method returns this value, the associated parameter will not be null. | ||
| ''' </param> | ||
| ''' <param name="members"> | ||
| ''' The list of field and property members that are promised to be not-null. | ||
| ''' </param> | ||
| Public Sub New(ReturnValue As Boolean, ParamArray members As String()) | ||
| Me.ReturnValue = ReturnValue | ||
| Me.Members = members | ||
| End Sub | ||
|
|
||
| ''' <summary>Gets the return value condition.</summary> | ||
| Public ReadOnly Property ReturnValue As Boolean | ||
|
|
||
| ''' <summary>Gets field or property member names.</summary> | ||
| Public ReadOnly Property Members As String() | ||
| End Class | ||
|
|
||
| End Namespace |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
...isionLabs.ReferenceAssemblyAnnotator/WellKnownTypes+MemberNotNullAttributeProvidedType.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| // Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved. | ||
| // Licensed under the MIT License. See LICENSE in the project root for license information. | ||
|
|
||
| namespace TunnelVisionLabs.ReferenceAssemblyAnnotator | ||
| { | ||
| using System; | ||
| using Mono.Cecil; | ||
| using Mono.Cecil.Rocks; | ||
|
|
||
| internal partial class WellKnownTypes | ||
| { | ||
| private sealed class MemberNotNullAttributeProvidedType : ProvidedAttributeType | ||
| { | ||
| public MemberNotNullAttributeProvidedType() | ||
| : base("System.Diagnostics.CodeAnalysis", "MemberNotNullAttribute") | ||
| { | ||
| } | ||
|
|
||
| protected override void ImplementAttribute(ModuleDefinition module, TypeDefinition attribute, WellKnownTypes wellKnownTypes, CustomAttributeFactory attributeFactory) | ||
| { | ||
| var constructor1 = MethodFactory.Constructor(wellKnownTypes.TypeSystem); | ||
| constructor1.Parameters.Add(new ParameterDefinition("member", ParameterAttributes.None, wellKnownTypes.TypeSystem.String)); | ||
| attribute.Methods.Add(constructor1); | ||
|
|
||
| var members = new ParameterDefinition("members", ParameterAttributes.None, wellKnownTypes.TypeSystem.String.MakeArrayType()); | ||
| members.CustomAttributes.Add(attributeFactory.ParamArray()); | ||
|
|
||
| var constructor2 = MethodFactory.Constructor(wellKnownTypes.TypeSystem); | ||
| constructor2.Parameters.Add(members); | ||
| attribute.Methods.Add(constructor2); | ||
|
|
||
| attribute.CustomAttributes.Add(attributeFactory.NullableContext(1)); | ||
| attribute.CustomAttributes.Add(attributeFactory.Nullable(0)); | ||
| attribute.CustomAttributes.Add(attributeFactory.AttributeUsage(AttributeTargets.Method | AttributeTargets.Property, inherited: false, allowMultiple: true)); | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's the first time I play with Cecil, so you'll likely want to triple-check I'm not doing anything stupid 😄