-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This allows us to start using C# 8.0 features even if we are targeting netstandard2.0 or netcoreapp2.x. Note that the polyfills are internal, so can not be used in public APIs. Nice introduction to this subject can be found at: - https://stu.dev/csharp8-doing-unsupported-things/ - https://www.meziantou.net/how-to-use-nullable-reference-types-in-dotnet-standard-2-0-and-dotnet-.htm We can now start to get "nullified" before .NET 5.
- Loading branch information
Showing
6 changed files
with
464 additions
and
8 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
<Project> | ||
|
||
<ItemGroup Condition=" '$(LangVersion)' == '8.0' and '$(TargetFramework)' != 'netcoreapp3.0' " > | ||
<Compile Include="$(MSBuildThisFileDirectory)/csharp8.0-polyfill/Index.cs" /> | ||
<Compile Include="$(MSBuildThisFileDirectory)/csharp8.0-polyfill/Range.cs" /> | ||
<Compile Include="$(MSBuildThisFileDirectory)/csharp8.0-polyfill/RuntimeHelpers.cs" /> | ||
<Compile Include="$(MSBuildThisFileDirectory)/csharp8.0-polyfill/NullableAttributes.cs" /> | ||
</ItemGroup> | ||
|
||
</Project> |
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,145 @@ | ||
// https://github.com/dotnet/corefx/blob/1597b894a2e9cac668ce6e484506eca778a85197/src/Common/src/CoreLib/System/Index.cs | ||
|
||
// 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. | ||
|
||
using System.Diagnostics; | ||
using System.Runtime.CompilerServices; | ||
|
||
namespace System | ||
{ | ||
/// <summary>Represent a type can be used to index a collection either from the start or the end.</summary> | ||
/// <remarks> | ||
/// Index is used by the C# compiler to support the new index syntax | ||
/// <code> | ||
/// int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ; | ||
/// int lastElement = someArray[^1]; // lastElement = 5 | ||
/// </code> | ||
/// </remarks> | ||
internal readonly struct Index : IEquatable<Index> | ||
{ | ||
private readonly int _value; | ||
|
||
/// <summary>Construct an Index using a value and indicating if the index is from the start or from the end.</summary> | ||
/// <param name="value">The index value. it has to be zero or positive number.</param> | ||
/// <param name="fromEnd">Indicating if the index is from the start or from the end.</param> | ||
/// <remarks> | ||
/// If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element. | ||
/// </remarks> | ||
[MethodImpl(MethodImplOptions.AggressiveInlining)] | ||
public Index(int value, bool fromEnd = false) | ||
{ | ||
if (value < 0) | ||
{ | ||
throw new ArgumentOutOfRangeException(nameof(value), "value must be non-negative"); | ||
} | ||
|
||
if (fromEnd) | ||
_value = ~value; | ||
else | ||
_value = value; | ||
} | ||
|
||
// The following private constructors mainly created for perf reason to avoid the checks | ||
private Index(int value) | ||
{ | ||
_value = value; | ||
} | ||
|
||
/// <summary>Create an Index pointing at first element.</summary> | ||
public static Index Start => new Index(0); | ||
|
||
/// <summary>Create an Index pointing at beyond last element.</summary> | ||
public static Index End => new Index(~0); | ||
|
||
/// <summary>Create an Index from the start at the position indicated by the value.</summary> | ||
/// <param name="value">The index value from the start.</param> | ||
[MethodImpl(MethodImplOptions.AggressiveInlining)] | ||
public static Index FromStart(int value) | ||
{ | ||
if (value < 0) | ||
{ | ||
throw new ArgumentOutOfRangeException(nameof(value), "value must be non-negative"); | ||
} | ||
|
||
return new Index(value); | ||
} | ||
|
||
/// <summary>Create an Index from the end at the position indicated by the value.</summary> | ||
/// <param name="value">The index value from the end.</param> | ||
[MethodImpl(MethodImplOptions.AggressiveInlining)] | ||
public static Index FromEnd(int value) | ||
{ | ||
if (value < 0) | ||
{ | ||
throw new ArgumentOutOfRangeException(nameof(value), "value must be non-negative"); | ||
} | ||
|
||
return new Index(~value); | ||
} | ||
|
||
/// <summary>Returns the index value.</summary> | ||
public int Value | ||
{ | ||
get | ||
{ | ||
if (_value < 0) | ||
return ~_value; | ||
else | ||
return _value; | ||
} | ||
} | ||
|
||
/// <summary>Indicates whether the index is from the start or the end.</summary> | ||
public bool IsFromEnd => _value < 0; | ||
|
||
/// <summary>Calculate the offset from the start using the giving collection length.</summary> | ||
/// <param name="length">The length of the collection that the Index will be used with. length has to be a positive value</param> | ||
/// <remarks> | ||
/// For performance reason, we don't validate the input length parameter and the returned offset value against negative values. | ||
/// we don't validate either the returned offset is greater than the input length. | ||
/// It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and | ||
/// then used to index a collection will get out of range exception which will be same affect as the validation. | ||
/// </remarks> | ||
[MethodImpl(MethodImplOptions.AggressiveInlining)] | ||
public int GetOffset(int length) | ||
{ | ||
int offset = _value; | ||
if (IsFromEnd) | ||
{ | ||
// offset = length - (~value) | ||
// offset = length + (~(~value) + 1) | ||
// offset = length + value + 1 | ||
|
||
offset += length + 1; | ||
} | ||
return offset; | ||
} | ||
|
||
#pragma warning disable CS8632 | ||
/// <summary>Indicates whether the current Index object is equal to another object of the same type.</summary> | ||
/// <param name="value">An object to compare with this object</param> | ||
public override bool Equals(object? value) => value is Index && _value == ((Index)value)._value; | ||
#pragma warning restore CS8632 | ||
|
||
/// <summary>Indicates whether the current Index object is equal to another Index object.</summary> | ||
/// <param name="other">An object to compare with this object</param> | ||
public bool Equals(Index other) => _value == other._value; | ||
|
||
/// <summary>Returns the hash code for this instance.</summary> | ||
public override int GetHashCode() => _value; | ||
|
||
/// <summary>Converts integer number to an Index.</summary> | ||
public static implicit operator Index(int value) => FromStart(value); | ||
|
||
/// <summary>Converts the value of the current Index object to its equivalent string representation.</summary> | ||
public override string ToString() | ||
{ | ||
if (IsFromEnd) | ||
return "^" + ((uint)Value).ToString(); | ||
|
||
return ((uint)Value).ToString(); | ||
} | ||
} | ||
} |
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,142 @@ | ||
#pragma warning disable MA0048 // File name must match type name | ||
#define INTERNAL_NULLABLE_ATTRIBUTES | ||
#if NETSTANDARD2_0 || NETCOREAPP2_0 || NETCOREAPP2_1 || NETCOREAPP2_2 || NET45 || NET451 || NET452 || NET6 || NET461 || NET462 || NET47 || NET471 || NET472 || NET48 | ||
|
||
// https://github.com/dotnet/corefx/blob/48363ac826ccf66fbe31a5dcb1dc2aab9a7dd768/src/Common/src/CoreLib/System/Diagnostics/CodeAnalysis/NullableAttributes.cs | ||
|
||
// Gist from: https://gist.github.com/meziantou/b681c1026799e8e048d47765d2176b2c | ||
|
||
// 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. | ||
|
||
namespace System.Diagnostics.CodeAnalysis | ||
{ | ||
/// <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary> | ||
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property, Inherited = false)] | ||
#if INTERNAL_NULLABLE_ATTRIBUTES | ||
internal | ||
#else | ||
public | ||
#endif | ||
sealed class AllowNullAttribute : Attribute | ||
{ } | ||
|
||
/// <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary> | ||
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property, Inherited = false)] | ||
#if INTERNAL_NULLABLE_ATTRIBUTES | ||
internal | ||
#else | ||
public | ||
#endif | ||
sealed class DisallowNullAttribute : Attribute | ||
{ } | ||
|
||
/// <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary> | ||
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.ReturnValue, Inherited = false)] | ||
#if INTERNAL_NULLABLE_ATTRIBUTES | ||
internal | ||
#else | ||
public | ||
#endif | ||
sealed class MaybeNullAttribute : Attribute | ||
{ } | ||
|
||
/// <summary>Specifies that an output will not be null even if the corresponding type allows it.</summary> | ||
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.ReturnValue, Inherited = false)] | ||
#if INTERNAL_NULLABLE_ATTRIBUTES | ||
internal | ||
#else | ||
public | ||
#endif | ||
sealed class NotNullAttribute : Attribute | ||
{ } | ||
|
||
/// <summary>Specifies that when a method returns <see cref="ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary> | ||
[AttributeUsage(AttributeTargets.Parameter, Inherited = false)] | ||
#if INTERNAL_NULLABLE_ATTRIBUTES | ||
internal | ||
#else | ||
public | ||
#endif | ||
sealed class MaybeNullWhenAttribute : Attribute | ||
{ | ||
/// <summary>Initializes the attribute with the specified return value condition.</summary> | ||
/// <param name="returnValue"> | ||
/// The return value condition. If the method returns this value, the associated parameter may be null. | ||
/// </param> | ||
public MaybeNullWhenAttribute(bool returnValue) => ReturnValue = returnValue; | ||
|
||
/// <summary>Gets the return value condition.</summary> | ||
public bool ReturnValue { get; } | ||
} | ||
|
||
/// <summary>Specifies that when a method returns <see cref="ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary> | ||
[AttributeUsage(AttributeTargets.Parameter, Inherited = false)] | ||
#if INTERNAL_NULLABLE_ATTRIBUTES | ||
internal | ||
#else | ||
public | ||
#endif | ||
sealed class NotNullWhenAttribute : Attribute | ||
{ | ||
/// <summary>Initializes the attribute with the specified return value condition.</summary> | ||
/// <param name="returnValue"> | ||
/// The return value condition. If the method returns this value, the associated parameter will not be null. | ||
/// </param> | ||
public NotNullWhenAttribute(bool returnValue) => ReturnValue = returnValue; | ||
|
||
/// <summary>Gets the return value condition.</summary> | ||
public bool ReturnValue { get; } | ||
} | ||
|
||
/// <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary> | ||
[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.ReturnValue, AllowMultiple = true, Inherited = false)] | ||
#if INTERNAL_NULLABLE_ATTRIBUTES | ||
internal | ||
#else | ||
public | ||
#endif | ||
sealed class NotNullIfNotNullAttribute : Attribute | ||
{ | ||
/// <summary>Initializes the attribute with the associated parameter name.</summary> | ||
/// <param name="parameterName"> | ||
/// The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null. | ||
/// </param> | ||
public NotNullIfNotNullAttribute(string parameterName) => ParameterName = parameterName; | ||
|
||
/// <summary>Gets the associated parameter name.</summary> | ||
public string ParameterName { get; } | ||
} | ||
|
||
/// <summary>Applied to a method that will never return under any circumstance.</summary> | ||
[AttributeUsage(AttributeTargets.Method, Inherited = false)] | ||
#if INTERNAL_NULLABLE_ATTRIBUTES | ||
internal | ||
#else | ||
public | ||
#endif | ||
sealed class DoesNotReturnAttribute : Attribute | ||
{ } | ||
|
||
/// <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary> | ||
[AttributeUsage(AttributeTargets.Parameter, Inherited = false)] | ||
#if INTERNAL_NULLABLE_ATTRIBUTES | ||
internal | ||
#else | ||
public | ||
#endif | ||
sealed class DoesNotReturnIfAttribute : Attribute | ||
{ | ||
/// <summary>Initializes the attribute with the specified parameter value.</summary> | ||
/// <param name="parameterValue"> | ||
/// The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to | ||
/// the associated parameter matches this value. | ||
/// </param> | ||
public DoesNotReturnIfAttribute(bool parameterValue) => ParameterValue = parameterValue; | ||
|
||
/// <summary>Gets the condition parameter value.</summary> | ||
public bool ParameterValue { get; } | ||
} | ||
} | ||
#endif |
Oops, something went wrong.