|
| 1 | +// Licensed to the .NET Foundation under one or more agreements. |
| 2 | +// The .NET Foundation licenses this file to you under the MIT license. |
| 3 | +// See the LICENSE file in the project root for more information. |
| 4 | + |
| 5 | +// This was copied from https://github.com/dotnet/runtime/blob/39b9607807f29e48cae4652cd74735182b31182e/src/libraries/System.Private.CoreLib/src/System/Diagnostics/CodeAnalysis/NullableAttributes.cs |
| 6 | +// and updated to have the scope of the attributes be internal. |
| 7 | + |
| 8 | +// ReSharper disable once CheckNamespace |
| 9 | +// ReSharper disable UnusedAutoPropertyAccessor.Global |
| 10 | +namespace System.Diagnostics.CodeAnalysis; |
| 11 | +#if !NETCOREAPP |
| 12 | + |
| 13 | +/// <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary> |
| 14 | +[AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property)] |
| 15 | +internal sealed class AllowNullAttribute : Attribute; |
| 16 | + |
| 17 | +/// <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary> |
| 18 | +[AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property)] |
| 19 | +internal sealed class DisallowNullAttribute : Attribute; |
| 20 | + |
| 21 | +/// <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary> |
| 22 | +[AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.ReturnValue)] |
| 23 | +internal sealed class MaybeNullAttribute : Attribute; |
| 24 | + |
| 25 | +/// <summary>Specifies that an output will not be null even if the corresponding type allows it.</summary> |
| 26 | +[AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.ReturnValue)] |
| 27 | +internal sealed class NotNullAttribute : Attribute; |
| 28 | + |
| 29 | +/// <summary> |
| 30 | +/// Specifies that when a method returns <see cref="ReturnValue" />, the parameter may be null even if the |
| 31 | +/// corresponding type disallows it. |
| 32 | +/// </summary> |
| 33 | +[AttributeUsage(AttributeTargets.Parameter)] |
| 34 | +internal sealed class MaybeNullWhenAttribute : Attribute { |
| 35 | + /// <summary>Initializes the attribute with the specified return value condition.</summary> |
| 36 | + /// <param name="returnValue"> |
| 37 | + /// The return value condition. If the method returns this value, the associated parameter may be null. |
| 38 | + /// </param> |
| 39 | + public MaybeNullWhenAttribute(bool returnValue) { |
| 40 | + ReturnValue = returnValue; |
| 41 | + } |
| 42 | + |
| 43 | + /// <summary> Gets the return value condition.</summary> |
| 44 | + public bool ReturnValue { get; } |
| 45 | +} |
| 46 | + |
| 47 | +/// <summary> |
| 48 | +/// Specifies that when a method returns <see cref="ReturnValue" />, the parameter will not be null even if the |
| 49 | +/// corresponding type allows it. |
| 50 | +/// </summary> |
| 51 | +[AttributeUsage(AttributeTargets.Parameter)] |
| 52 | +internal sealed class NotNullWhenAttribute : Attribute { |
| 53 | + /// <summary>Initializes the attribute with the specified return value condition.</summary> |
| 54 | + /// <param name="returnValue"> |
| 55 | + /// The return value condition. If the method returns this value, the associated parameter will not be null. |
| 56 | + /// </param> |
| 57 | + public NotNullWhenAttribute(bool returnValue) { |
| 58 | + ReturnValue = returnValue; |
| 59 | + } |
| 60 | + |
| 61 | + /// <summary>Gets the return value condition.</summary> |
| 62 | + public bool ReturnValue { get; } |
| 63 | +} |
| 64 | + |
| 65 | +/// <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary> |
| 66 | +[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.ReturnValue, AllowMultiple = true)] |
| 67 | +internal sealed class NotNullIfNotNullAttribute : Attribute { |
| 68 | + /// <summary>Initializes the attribute with the associated parameter name.</summary> |
| 69 | + /// <param name="parameterName"> |
| 70 | + /// The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null. |
| 71 | + /// </param> |
| 72 | + public NotNullIfNotNullAttribute(string parameterName) { |
| 73 | + ParameterName = parameterName; |
| 74 | + } |
| 75 | + |
| 76 | + /// <summary>Gets the associated parameter name.</summary> |
| 77 | + public string ParameterName { get; } |
| 78 | +} |
| 79 | + |
| 80 | +/// <summary>Applied to a method that will never return under any circumstance.</summary> |
| 81 | +[AttributeUsage(AttributeTargets.Method, Inherited = false)] |
| 82 | +internal sealed class DoesNotReturnAttribute : Attribute; |
| 83 | + |
| 84 | +/// <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary> |
| 85 | +[AttributeUsage(AttributeTargets.Parameter)] |
| 86 | +internal sealed class DoesNotReturnIfAttribute : Attribute { |
| 87 | + /// <summary>Initializes the attribute with the specified parameter value.</summary> |
| 88 | + /// <param name="parameterValue"> |
| 89 | + /// The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument |
| 90 | + /// to |
| 91 | + /// the associated parameter matches this value. |
| 92 | + /// </param> |
| 93 | + public DoesNotReturnIfAttribute(bool parameterValue) { |
| 94 | + ParameterValue = parameterValue; |
| 95 | + } |
| 96 | + |
| 97 | + /// <summary>Gets the condition parameter value.</summary> |
| 98 | + public bool ParameterValue { get; } |
| 99 | +} |
| 100 | + |
| 101 | +#endif |
| 102 | + |
| 103 | +#if !NETCOREAPP |
| 104 | + |
| 105 | +/// <summary> |
| 106 | +/// Specifies that the method or property will ensure that the listed field and property members have not-null |
| 107 | +/// values. |
| 108 | +/// </summary> |
| 109 | +[AttributeUsage(AttributeTargets.Method | AttributeTargets.Property, Inherited = false, AllowMultiple = true)] |
| 110 | +internal sealed class MemberNotNullAttribute : Attribute { |
| 111 | + /// <summary>Initializes the attribute with a field or property member.</summary> |
| 112 | + /// <param name="member"> |
| 113 | + /// The field or property member that is promised to be not-null. |
| 114 | + /// </param> |
| 115 | + public MemberNotNullAttribute(string member) { |
| 116 | + Members = [member]; |
| 117 | + } |
| 118 | + |
| 119 | + /// <summary>Initializes the attribute with the list of field and property members.</summary> |
| 120 | + /// <param name="members"> |
| 121 | + /// The list of field and property members that are promised to be not-null. |
| 122 | + /// </param> |
| 123 | + public MemberNotNullAttribute(params string[] members) { |
| 124 | + Members = members; |
| 125 | + } |
| 126 | + |
| 127 | + /// <summary>Gets field or property member names.</summary> |
| 128 | + public string[] Members { get; } |
| 129 | +} |
| 130 | + |
| 131 | +/// <summary> |
| 132 | +/// Specifies that the method or property will ensure that the listed field and property members have not-null |
| 133 | +/// values when returning with the specified return value condition. |
| 134 | +/// </summary> |
| 135 | +[AttributeUsage(AttributeTargets.Method | AttributeTargets.Property, Inherited = false, AllowMultiple = true)] |
| 136 | +internal sealed class MemberNotNullWhenAttribute : Attribute { |
| 137 | + /// <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary> |
| 138 | + /// <param name="returnValue"> |
| 139 | + /// The return value condition. If the method returns this value, the associated parameter will not be null. |
| 140 | + /// </param> |
| 141 | + /// <param name="member"> |
| 142 | + /// The field or property member that is promised to be not-null. |
| 143 | + /// </param> |
| 144 | + public MemberNotNullWhenAttribute(bool returnValue, string member) { |
| 145 | + ReturnValue = returnValue; |
| 146 | + Members = [member]; |
| 147 | + } |
| 148 | + |
| 149 | + /// <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary> |
| 150 | + /// <param name="returnValue"> |
| 151 | + /// The return value condition. If the method returns this value, the associated parameter will not be null. |
| 152 | + /// </param> |
| 153 | + /// <param name="members"> |
| 154 | + /// The list of field and property members that are promised to be not-null. |
| 155 | + /// </param> |
| 156 | + public MemberNotNullWhenAttribute(bool returnValue, params string[] members) { |
| 157 | + ReturnValue = returnValue; |
| 158 | + Members = members; |
| 159 | + } |
| 160 | + |
| 161 | + /// <summary>Gets the return value condition.</summary> |
| 162 | + public bool ReturnValue { get; } |
| 163 | + |
| 164 | + /// <summary>Gets field or property member names.</summary> |
| 165 | + public string[] Members { get; } |
| 166 | +} |
| 167 | + |
| 168 | +#endif |
0 commit comments