Add SupportedOSPlatformGuardAttribute

AigioL · AigioL · commit 0c1fc3db0cac · 2022-01-28T18:08:32.000+08:00
diff --git a/OperatingSystem2.android.cs b/OperatingSystem2.android.cs
@@ -5,6 +5,7 @@
 #if __HAVE_XAMARIN_ESSENTIALS__
 using Xamarin.Essentials;
 #endif
+using System.Runtime.Versioning;
 
 namespace System
 {
@@ -13,6 +14,7 @@ partial class OperatingSystem2
         /// <summary>
         /// 指示当前应用程序是否正在 Android 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("android")]
         public static bool IsAndroid =>
 #if __ANDROID__
             true;
@@ -44,6 +46,7 @@ partial class OperatingSystem2
         /// <summary>
         /// 指示当前应用程序是否正在 Windows Subsystem for Android™️ 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("android")]
         public static bool IsRunningOnWSA =>
 #if __ANDROID__
             _IsRunningOnWSA.Value;
@@ -56,6 +59,7 @@ partial class OperatingSystem2
         /// </summary>
         /// <param name="sdkInt"></param>
         /// <returns></returns>
+        [SupportedOSPlatformGuard("android")]
         public static bool IsAndroidVersionAtLeast(int sdkInt)
         {
 #if __ANDROID__
@@ -71,6 +75,7 @@ public static bool IsAndroidVersionAtLeast(int sdkInt)
         /// </summary>
         /// <param name="sdkInt"></param>
         /// <returns></returns>
+        [SupportedOSPlatformGuard("android")]
         public static bool IsAndroidVersionAtLeast(BuildVersionCodes sdkInt)
         {
             return Build.VERSION.SdkInt >= sdkInt;
@@ -85,6 +90,7 @@ public static bool IsAndroidVersionAtLeast(BuildVersionCodes sdkInt)
         /// <param name="build"></param>
         /// <param name="revision"></param>
         /// <returns></returns>
+        [SupportedOSPlatformGuard("android")]
         public static bool IsAndroidVersionAtLeast(int major, int minor = 0, int build = 0, int revision = 0)
         {
 #if NET5_0 || NET6_0 || NET7_0
diff --git a/OperatingSystem2.application.cs b/OperatingSystem2.application.cs
@@ -1,7 +1,5 @@
-using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Text;
 
 namespace System
 {
diff --git a/OperatingSystem2.browser.cs b/OperatingSystem2.browser.cs
@@ -1,6 +1,7 @@
-﻿#if __HAVE_RUNTIME_INFORMATION__
+#if __HAVE_RUNTIME_INFORMATION__
 using System.Runtime.InteropServices;
 #endif
+using System.Runtime.Versioning;
 
 namespace System
 {
@@ -9,6 +10,7 @@ partial class OperatingSystem2
         /// <summary>
         /// 指示当前应用程序是否在浏览器中作为 WASM 运行。
         /// </summary>
+        [SupportedOSPlatformGuard("browser")]
         public static bool IsBrowser =>
 #if NET5_0 || NET6_0 || NET7_0
             OperatingSystem.IsBrowser();
diff --git a/OperatingSystem2.csproj b/OperatingSystem2.csproj
@@ -21,7 +21,7 @@
     <Description>表示有关操作系统的信息，如版本和平台标识符的通用库。</Description>
     <PackageId>OperatingSystem2</PackageId>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <Version>1.4.2.1</Version>
+    <Version>1.4.3</Version>
     <AndroidUseIntermediateDesignerFile>false</AndroidUseIntermediateDesignerFile>
     <DisableImplicitNamespaceImports>true</DisableImplicitNamespaceImports>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
@@ -43,7 +43,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All"/>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
   </ItemGroup>
 
 </Project>
diff --git a/OperatingSystem2.freebsd.cs b/OperatingSystem2.freebsd.cs
@@ -1,6 +1,7 @@
 #if NETCOREAPP3_0 || NETCOREAPP3_1
 using System.Runtime.InteropServices;
 #endif
+using System.Runtime.Versioning;
 
 namespace System
 {
@@ -9,6 +10,7 @@ partial class OperatingSystem2
         /// <summary>
         /// 指示当前应用程序是否正在 FreeBSD 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("freebsd")]
         public static bool IsFreeBSD =>
 #if NET5_0 || NET6_0 || NET7_0
             OperatingSystem.IsFreeBSD();
@@ -26,6 +28,7 @@ partial class OperatingSystem2
         /// <param name="build"></param>
         /// <param name="revision"></param>
         /// <returns></returns>
+        [SupportedOSPlatformGuard("freebsd")]
         public static bool IsFreeBSDVersionAtLeast(int major, int minor = 0, int build = 0, int revision = 0)
         {
 #if NET5_0 || NET6_0 || NET7_0
diff --git a/OperatingSystem2.ios.cs b/OperatingSystem2.ios.cs
@@ -1,6 +1,7 @@
 #if __HAVE_XAMARIN_ESSENTIALS__
 using Xamarin.Essentials;
 #endif
+using System.Runtime.Versioning;
 
 namespace System
 {
@@ -9,6 +10,8 @@ partial class OperatingSystem2
         /// <summary>
         /// 指示当前应用程序是否正在 iOS 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("ios")]
+        [SupportedOSPlatformGuard("maccatalyst")]
         public static bool IsIOS =>
 #if __MACOS__ || NET5_0_WINDOWS || NET6_0_WINDOWS || NET7_0_WINDOWS || __ANDROID__ || __TVOS__ || __WATCHOS__
             false;
@@ -29,6 +32,8 @@ partial class OperatingSystem2
         /// <param name="minor"></param>
         /// <param name="build"></param>
         /// <returns></returns>
+        [SupportedOSPlatformGuard("ios")]
+        [SupportedOSPlatformGuard("maccatalyst")]
         public static bool IsIOSVersionAtLeast(int major, int minor = 0, int build = 0)
         {
 #if __MACOS__ || NET5_0_WINDOWS || NET6_0_WINDOWS || NET7_0_WINDOWS || __ANDROID__ || __TVOS__ || __WATCHOS__
diff --git a/OperatingSystem2.linux.cs b/OperatingSystem2.linux.cs
@@ -1,6 +1,7 @@
 #if __HAVE_RUNTIME_INFORMATION__
 using System.Runtime.InteropServices;
 #endif
+using System.Runtime.Versioning;
 
 namespace System
 {
@@ -9,6 +10,7 @@ partial class OperatingSystem2
         /// <summary>
         /// 指示当前应用程序是否正在 Linux 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("linux")]
         public static bool IsLinux =>
 #if NETSTANDARD1_0 || NET5_0_WINDOWS || NET6_0_WINDOWS || NET7_0_WINDOWS || __MACOS__ || __IOS__ || __WATCHOS__ || __TVOS__ || WINDOWS_UWP
             false;
diff --git a/OperatingSystem2.macos.cs b/OperatingSystem2.macos.cs
@@ -4,6 +4,7 @@
 #if __HAVE_XAMARIN_ESSENTIALS__
 using Xamarin.Essentials;
 #endif
+using System.Runtime.Versioning;
 
 namespace System
 {
@@ -12,6 +13,7 @@ partial class OperatingSystem2
         /// <summary>
         /// 指示当前应用程序是否正在 macOS 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("macos")]
         public static bool IsMacOS =>
 #if NET5_0_WINDOWS || NET6_0_WINDOWS || NET7_0_WINDOWS || __ANDROID__ || __TVOS__ || __WATCHOS__ || WINDOWS_UWP
             false;
@@ -34,6 +36,7 @@ partial class OperatingSystem2
         /// <param name="minor"></param>
         /// <param name="build"></param>
         /// <returns></returns>
+        [SupportedOSPlatformGuard("macos")]
         public static bool IsMacOSVersionAtLeast(int major, int minor = 0, int build = 0)
         {
 #if NET5_0_WINDOWS || NET6_0_WINDOWS || NET7_0_WINDOWS || __ANDROID__ || __TVOS__ || __WATCHOS__ || WINDOWS_UWP
diff --git a/OperatingSystem2.tvos.cs b/OperatingSystem2.tvos.cs
@@ -1,6 +1,7 @@
 #if __HAVE_XAMARIN_ESSENTIALS__
 using Xamarin.Essentials;
 #endif
+using System.Runtime.Versioning;
 
 namespace System
 {
@@ -9,6 +10,7 @@ partial class OperatingSystem2
         /// <summary>
         /// 指示当前应用程序是否正在 tvOS 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("tvos")]
         public static bool IsTvOS =>
 #if __MACOS__ || NET5_0_WINDOWS || NET6_0_WINDOWS || NET7_0_WINDOWS || __ANDROID__ || __IOS__ || __WATCHOS__
             false;
@@ -29,6 +31,7 @@ partial class OperatingSystem2
         /// <param name="minor"></param>
         /// <param name="build"></param>
         /// <returns></returns>
+        [SupportedOSPlatformGuard("tvos")]
         public static bool IsTvOSVersionAtLeast(int major, int minor = 0, int build = 0)
         {
 #if __MACOS__ || NET5_0_WINDOWS || NET6_0_WINDOWS || NET7_0_WINDOWS || __ANDROID__ || __IOS__ || __WATCHOS__
diff --git a/OperatingSystem2.watchos.cs b/OperatingSystem2.watchos.cs
@@ -1,6 +1,7 @@
 #if __HAVE_XAMARIN_ESSENTIALS__
 using Xamarin.Essentials;
 #endif
+using System.Runtime.Versioning;
 
 namespace System
 {
@@ -9,6 +10,7 @@ partial class OperatingSystem2
         /// <summary>
         /// 指示当前应用程序是否正在 watchOS 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("watchos")]
         public static bool IsWatchOS =>
 #if __MACOS__ || NET5_0_WINDOWS || NET6_0_WINDOWS || NET7_0_WINDOWS || __ANDROID__ || __TVOS__ || __IOS__
             false;
@@ -29,6 +31,7 @@ partial class OperatingSystem2
         /// <param name="minor"></param>
         /// <param name="build"></param>
         /// <returns></returns>
+        [SupportedOSPlatformGuard("watchos")]
         public static bool IsWatchOSVersionAtLeast(int major, int minor = 0, int build = 0)
         {
 #if __MACOS__ || NET5_0_WINDOWS || NET6_0_WINDOWS || NET7_0_WINDOWS || __ANDROID__ || __TVOS__ || __IOS__
diff --git a/OperatingSystem2.windows.cs b/OperatingSystem2.windows.cs
@@ -1,4 +1,5 @@
 using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
 using System.Text;
 #if __HAVE_XAMARIN_ESSENTIALS__
 using Xamarin.Essentials;
@@ -14,6 +15,7 @@ partial class OperatingSystem2
         /// <summary>
         /// 指示当前应用程序是否正在 Windows 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("windows")]
         public static bool IsWindows =>
 #if NETSTANDARD1_0 || __MACOS__ || __ANDROID__ || __IOS__ || __WATCHOS__ || __TVOS__
             false;
@@ -35,6 +37,7 @@ partial class OperatingSystem2
         /// <param name="build"></param>
         /// <param name="revision"></param>
         /// <returns></returns>
+        [SupportedOSPlatformGuard("windows")]
         public static bool IsWindowsVersionAtLeast(int major, int minor = 0, int build = 0, int revision = 0)
         {
 #if NETSTANDARD1_0 || __MACOS__ || __ANDROID__ || __IOS__ || __WATCHOS__ || __TVOS__
@@ -109,6 +112,7 @@ static Version WindowsVersion_()
         /// <summary>
         /// 指示当前应用程序是否正在 Windows 7(NT 6.1) 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("windows7.0")]
         public static bool IsWindows7 =>
 #if NETSTANDARD1_0 || __MACOS__ || __ANDROID__ || __IOS__ || __WATCHOS__ || __TVOS__ || WINDOWS_UWP
             false;
@@ -124,6 +128,7 @@ static Version WindowsVersion_()
         /// <summary>
         /// 指示当前应用程序是否正在 Windows Server 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("windows")]
         public static bool IsWindowsServer =>
 #if NETSTANDARD1_0 || __MACOS__ || __ANDROID__ || __IOS__ || __WATCHOS__ || __TVOS__
             false;
@@ -140,6 +145,7 @@ static Version WindowsVersion_()
         /// <summary>
         /// 指示当前应用程序是否正在 Windows 10 或更高版本上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("windows10.0")]
         public static bool IsWindows10AtLeast =>
 #if NETSTANDARD1_0 || __MACOS__ || __ANDROID__ || __IOS__ || __WATCHOS__ || __TVOS__
             false;
@@ -151,6 +157,7 @@ static Version WindowsVersion_()
         /// <summary>
         /// 指示当前应用程序是否正在 Windows 11 或更高版本上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("windows10.0.22000")]
         public static bool IsWindows11AtLeast =>
 #if NETSTANDARD1_0 || __MACOS__ || __ANDROID__ || __IOS__ || __WATCHOS__ || __TVOS__
             false;
@@ -205,6 +212,7 @@ static bool IsRunningAsUwp_()
         /// <summary>
         /// 指示当前应用程序是否正在 UWP 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("windows")]
         public static bool IsRunningAsUwp =>
 #if WINDOWS_UWP
             true;
@@ -223,6 +231,7 @@ static bool IsRunningAsUwp_()
         /// <summary>
         /// 指示当前应用程序是否正在 Xbox 上运行。
         /// </summary>
+        [SupportedOSPlatformGuard("windows")]
         public static bool IsRunningOnXbox =>
 #if NETSTANDARD1_0 || NETSTANDARD1_1 || __MACOS__ || __ANDROID__ || __IOS__ || __WATCHOS__ || __TVOS__
             false;
diff --git a/Runtime/Versioning/PlatformAttributes.cs b/Runtime/Versioning/PlatformAttributes.cs
@@ -0,0 +1,62 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// https://github.com/buyaa-n/runtime/blob/main/src/libraries/System.Private.CoreLib/src/System/Runtime/Versioning/PlatformAttributes.cs
+
+namespace System.Runtime.Versioning
+{
+#if !NET5_0 || NET5_0_WINDOWS
+    abstract class OSPlatformAttribute : Attribute
+    {
+        private protected OSPlatformAttribute(string platformName)
+        {
+            PlatformName = platformName;
+        }
+        public string PlatformName { get; }
+    }
+#endif
+
+#if !(NET6_0 || NET6_0_ANDROID || NET6_0_IOS || NET6_0_MACCATALYST || NET6_0_MACOS10_14 || NET6_0_WINDOWS || NET7_0 || NET7_0_ANDROID || NET7_0_IOS || NET7_0_MACCATALYST || NET7_0_MACOS10_14 || NET7_0_WINDOWS)
+
+    /// <summary>
+    /// Annotates a custom guard field, property or method with a supported platform name and optional version.
+    /// Multiple attributes can be applied to indicate guard for multiple supported platforms.
+    /// </summary>
+    /// <remarks>
+    /// Callers can apply a <see cref="System.Runtime.Versioning.SupportedOSPlatformGuardAttribute " /> to a field, property or method
+    /// and use that field, property or method in a conditional or assert statements in order to safely call platform specific APIs.
+    ///
+    /// The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
+    /// </remarks>
+    [AttributeUsage(AttributeTargets.Field |
+                    AttributeTargets.Method |
+                    AttributeTargets.Property,
+                    AllowMultiple = true, Inherited = false)]
+    sealed class SupportedOSPlatformGuardAttribute : OSPlatformAttribute
+    {
+        public SupportedOSPlatformGuardAttribute(string platformName) : base(platformName)
+        {
+        }
+    }
+
+    ///// <summary>
+    ///// Annotates the custom guard field, property or method with an unsupported platform name and optional version.
+    ///// Multiple attributes can be applied to indicate guard for multiple unsupported platforms.
+    ///// </summary>
+    ///// <remarks>
+    ///// Callers can apply a <see cref="System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute " /> to a field, property or method
+    ///// and use that  field, property or method in a conditional or assert statements as a guard to safely call APIs unsupported on those platforms.
+    /////
+    ///// The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
+    ///// </remarks>
+    //[AttributeUsage(AttributeTargets.Field |
+    //                AttributeTargets.Method |
+    //                AttributeTargets.Property,
+    //                AllowMultiple = true, Inherited = false)]
+    //sealed class UnsupportedOSPlatformGuardAttribute : OSPlatformAttribute
+    //{
+    //    public UnsupportedOSPlatformGuardAttribute(string platformName) : base(platformName)
+    //    {
+    //    }
+    //}
+#endif
+}

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,5 @@`
`1`		`-using System;`
`2`	`1`	`using System.Collections.Generic;`
`3`	`2`	`using System.Linq;`
`4`		`-using System.Text;`
`5`	`3`
`6`	`4`	`namespace System`
`7`	`5`	`{`