forked from dotnet/runtime
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add IsOSPlatformOrLater and IsOSPlatformEarlierThan methods (dotnet#3…
…9005) * add tests for IsOSPlatformOrLater and IsOSPlatformEarlierThan methods * add IsOSPlatformOrLater and IsOSPlatformEarlierThan methods * add xml docs that explain what the API does and what input is supported * address code review feedback * numbers in the middle of the platform name are not supported
- Loading branch information
1 parent
385efa8
commit 3480a74
Showing
6 changed files
with
390 additions
and
1 deletion.
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
131 changes: 131 additions & 0 deletions
131
...c/System/Runtime/InteropServices/RuntimeInformation/RuntimeInformation.PlatformVersion.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,131 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
|
||
namespace System.Runtime.InteropServices | ||
{ | ||
public static partial class RuntimeInformation | ||
{ | ||
/// <summary> | ||
/// Check for the OS with a >= version comparison. Used to guard APIs that were added in the given OS release. | ||
/// </summary> | ||
/// <param name="platformName">OS name concatenated with a version number.</param> | ||
/// <remarks>The version number must contain at least major and minor numbers separated with a dot. | ||
/// Example: "ios14.0" is OK, "ios14" is NOT OK.</remarks> | ||
public static bool IsOSPlatformOrLater(string platformName) | ||
{ | ||
(OSPlatform platform, Version version) = Parse(platformName); | ||
|
||
return IsOSPlatformOrLater(platform, version.Major, version.Minor, version.Build, version.Revision); | ||
} | ||
|
||
/// <summary> | ||
/// Check for the OS with a >= version comparison. Used to guard APIs that were added in the given OS release. | ||
/// </summary> | ||
public static bool IsOSPlatformOrLater(OSPlatform osPlatform, int major) | ||
=> IsOSPlatform(osPlatform) && Environment.OSVersion.Version.Major >= major; | ||
|
||
/// <summary> | ||
/// Check for the OS with a >= version comparison. Used to guard APIs that were added in the given OS release. | ||
/// </summary> | ||
public static bool IsOSPlatformOrLater(OSPlatform osPlatform, int major, int minor) | ||
=> IsOSPlatform(osPlatform) && IsOSVersionOrLater(major, minor, int.MinValue, int.MinValue); | ||
|
||
/// <summary> | ||
/// Check for the OS with a >= version comparison. Used to guard APIs that were added in the given OS release. | ||
/// </summary> | ||
public static bool IsOSPlatformOrLater(OSPlatform osPlatform, int major, int minor, int build) | ||
=> IsOSPlatform(osPlatform) && IsOSVersionOrLater(major, minor, build, int.MinValue); | ||
|
||
/// <summary> | ||
/// Check for the OS with a >= version comparison. Used to guard APIs that were added in the given OS release. | ||
/// </summary> | ||
public static bool IsOSPlatformOrLater(OSPlatform osPlatform, int major, int minor, int build, int revision) | ||
=> IsOSPlatform(osPlatform) && IsOSVersionOrLater(major, minor, build, revision); | ||
|
||
/// <summary> | ||
/// Check for the OS with a < version comparison. Used to guard APIs that were obsoleted or removed in the given OS release. | ||
/// </summary> | ||
/// <param name="platformName">OS name concatenated with a version number.</param> | ||
/// <remarks>The version number must contain at least major and minor numbers separated with a dot. | ||
/// Example: "ios14.0" is OK, "ios14" is NOT OK.</remarks> | ||
public static bool IsOSPlatformEarlierThan(string platformName) | ||
{ | ||
(OSPlatform platform, Version version) = Parse(platformName); | ||
|
||
return IsOSPlatformEarlierThan(platform, version.Major, version.Minor, version.Build, version.Revision); | ||
} | ||
|
||
/// <summary> | ||
/// Check for the OS with a < version comparison. Used to guard APIs that were obsoleted or removed in the given OS release. | ||
/// </summary> | ||
public static bool IsOSPlatformEarlierThan(OSPlatform osPlatform, int major) | ||
=> IsOSPlatform(osPlatform) && Environment.OSVersion.Version.Major < major; | ||
|
||
/// <summary> | ||
/// Check for the OS with a < version comparison. Used to guard APIs that were obsoleted or removed in the given OS release. | ||
/// </summary> | ||
public static bool IsOSPlatformEarlierThan(OSPlatform osPlatform, int major, int minor) | ||
=> IsOSPlatform(osPlatform) && !IsOSVersionOrLater(major, minor, int.MinValue, int.MinValue); | ||
|
||
/// <summary> | ||
/// Check for the OS with a < version comparison. Used to guard APIs that were obsoleted or removed in the given OS release. | ||
/// </summary> | ||
public static bool IsOSPlatformEarlierThan(OSPlatform osPlatform, int major, int minor, int build) | ||
=> IsOSPlatform(osPlatform) && !IsOSVersionOrLater(major, minor, build, int.MinValue); | ||
|
||
/// <summary> | ||
/// Check for the OS with a < version comparison. Used to guard APIs that were obsoleted or removed in the given OS release. | ||
/// </summary> | ||
public static bool IsOSPlatformEarlierThan(OSPlatform osPlatform, int major, int minor, int build, int revision) | ||
=> IsOSPlatform(osPlatform) && !IsOSVersionOrLater(major, minor, build, revision); | ||
|
||
private static bool IsOSVersionOrLater(int major, int minor, int build, int revision) | ||
{ | ||
Version current = Environment.OSVersion.Version; | ||
if (current.Major != major) | ||
{ | ||
return current.Major > major; | ||
} | ||
if (current.Minor != minor) | ||
{ | ||
return current.Minor > minor; | ||
} | ||
if (current.Build != build) | ||
{ | ||
return current.Build > build; | ||
} | ||
|
||
return current.Revision >= revision; | ||
} | ||
|
||
private static (OSPlatform, Version) Parse(string platformName) | ||
{ | ||
if (platformName == null) | ||
{ | ||
throw new ArgumentNullException(nameof(platformName)); | ||
} | ||
if (platformName.Length == 0) | ||
{ | ||
throw new ArgumentException(SR.Argument_EmptyValue, nameof(platformName)); | ||
} | ||
|
||
// iterate from the begining, as digits in the middle of the names are not supported by design | ||
for (int i = 0; i < platformName.Length; i++) | ||
{ | ||
if (char.IsDigit(platformName[i])) | ||
{ | ||
if (i > 0 && Version.TryParse(platformName.AsSpan(i), out Version? version)) | ||
{ | ||
return (OSPlatform.Create(platformName.Substring(0, i)), version); | ||
} | ||
else | ||
{ | ||
break; | ||
} | ||
} | ||
} | ||
|
||
throw new ArgumentException(SR.Format(SR.Argument_InvalidPlatfromName, platformName), nameof(platformName)); | ||
} | ||
} | ||
} |
Oops, something went wrong.