Merge pull request #6362 from peppy/has-flags-fast

Bring back `HasFlagsFast`

CodeAnalysis/BannedSymbols.txt

@@ -2,6 +2,7 @@ M:System.Object.Equals(System.Object,System.Object)~System.Boolean;Don't use obj
 M:System.Object.Equals(System.Object)~System.Boolean;Don't use object.Equals. Use IEquatable<T> or EqualityComparer<T>.Default instead.
 M:System.ValueType.Equals(System.Object)~System.Boolean;Don't use object.Equals(Fallbacks to ValueType). Use IEquatable<T> or EqualityComparer<T>.Default instead.
 T:System.IComparable;Don't use non-generic IComparable. Use generic version instead.
+M:System.Enum.HasFlag(System.Enum);Use osu.Framework.Extensions.EnumExtensions.HasFlagFast<T>() instead.
 F:System.UriKind.RelativeOrAbsolute;Incompatible results when run on mono (see https://www.mono-project.com/docs/faq/known-issues/urikind-relativeorabsolute/). Use Validation.TryParseUri(string, out Uri?) instead.
 M:System.Threading.Tasks.Task.Wait();Don't use Task.Wait. Use Task.WaitSafely() to ensure we avoid deadlocks.
 M:System.Guid.#ctor;Probably meaning to use Guid.NewGuid() instead. If actually wanting empty, use Guid.Empty.

osu.Framework.Android/Graphics/Video/AndroidVideoDecoder.cs

@@ -7,6 +7,7 @@
 using System.Runtime.InteropServices;
 using FFmpeg.AutoGen;
 using Java.Interop;
+using osu.Framework.Extensions.EnumExtensions;
 using osu.Framework.Graphics.Rendering;
 using osu.Framework.Graphics.Video;
 using osu.Framework.Logging;
@@ -154,7 +155,7 @@ public AndroidVideoDecoder(IRenderer renderer, Stream videoStream)
             HardwareVideoDecoder targetHwDecoders
         )
         {
-            if (targetHwDecoders.HasFlag(HardwareVideoDecoder.MediaCodec))
+            if (targetHwDecoders.HasFlagFast(HardwareVideoDecoder.MediaCodec))
             {
                 string? formatName = Marshal.PtrToStringAnsi((IntPtr)inputFormat->name);
 

osu.Framework.Benchmarks/BenchmarkEnum.cs

@@ -0,0 +1,42 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System;
+using BenchmarkDotNet.Attributes;
+using osu.Framework.Extensions.EnumExtensions;
+
+namespace osu.Framework.Benchmarks
+{
+    [MemoryDiagnoser]
+    public class BenchmarkEnum
+    {
+        [Benchmark]
+        public bool HasFlag()
+        {
+#pragma warning disable RS0030 // (banned API)
+            return (FlagsEnum.Flag2 | FlagsEnum.Flag3).HasFlag(FlagsEnum.Flag2);
+#pragma warning restore RS0030
+        }
+
+        [Benchmark]
+        public bool BitwiseAnd()
+        {
+            return ((FlagsEnum.Flag2 | FlagsEnum.Flag3) & FlagsEnum.Flag2) > 0;
+        }
+
+        [Benchmark]
+        public bool HasFlagFast()
+        {
+            return (FlagsEnum.Flag2 | FlagsEnum.Flag3).HasFlagFast(FlagsEnum.Flag2);
+        }
+
+        [Flags]
+        private enum FlagsEnum
+        {
+            Flag1 = 1,
+            Flag2 = 2,
+            Flag3 = 4,
+            Flag4 = 8
+        }
+    }
+}

osu.Framework.Tests/Visual/Containers/TestSceneSafeAreaOverrides.cs

@@ -1,6 +1,7 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using osu.Framework.Extensions.EnumExtensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
@@ -50,10 +51,10 @@ public TestSceneSafeAreaOverrides()
 
         private void addBoxAssert(OverrideTestContainer container)
         {
-            bool leftOverridden = container.SafeAreaContainer.SafeAreaOverrideEdges.HasFlag(Edges.Left);
-            bool topOverridden = container.SafeAreaContainer.SafeAreaOverrideEdges.HasFlag(Edges.Top);
-            bool rightOverridden = container.SafeAreaContainer.SafeAreaOverrideEdges.HasFlag(Edges.Right);
-            bool bottomOverridden = container.SafeAreaContainer.SafeAreaOverrideEdges.HasFlag(Edges.Bottom);
+            bool leftOverridden = container.SafeAreaContainer.SafeAreaOverrideEdges.HasFlagFast(Edges.Left);
+            bool topOverridden = container.SafeAreaContainer.SafeAreaOverrideEdges.HasFlagFast(Edges.Top);
+            bool rightOverridden = container.SafeAreaContainer.SafeAreaOverrideEdges.HasFlagFast(Edges.Right);
+            bool bottomOverridden = container.SafeAreaContainer.SafeAreaOverrideEdges.HasFlagFast(Edges.Bottom);
 
             AddAssert($"\"{container.Name}\" overrides correctly", () =>
                 leftOverridden == container.SafeAreaContainer.Padding.Left < 0

osu.Framework.Tests/Visual/Drawables/TestSceneIsMaskedAway.cs

@@ -4,6 +4,7 @@
 #nullable disable
 
 using NUnit.Framework;
+using osu.Framework.Extensions.EnumExtensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
@@ -84,7 +85,7 @@ public void TestBoxSlightlyOutOfBoundsMasking(Anchor anchor)
                         Anchor = anchor,
                         Origin = anchor,
                         Size = new Vector2(10),
-                        Position = new Vector2(anchor.HasFlag(Anchor.x0) ? -5 : 5, anchor.HasFlag(Anchor.y0) ? -5 : 5),
+                        Position = new Vector2(anchor.HasFlagFast(Anchor.x0) ? -5 : 5, anchor.HasFlagFast(Anchor.y0) ? -5 : 5),
                     }
                 };
             });
@@ -117,7 +118,7 @@ public void TestBoxFullyOutOfBoundsMasking(Anchor anchor)
                         Anchor = anchor,
                         Origin = anchor,
                         Size = new Vector2(10),
-                        Position = new Vector2(anchor.HasFlag(Anchor.x0) ? -20 : 20, anchor.HasFlag(Anchor.y0) ? -20 : 20),
+                        Position = new Vector2(anchor.HasFlagFast(Anchor.x0) ? -20 : 20, anchor.HasFlagFast(Anchor.y0) ? -20 : 20),
                     }
                 };
             });

osu.Framework.Tests/Visual/UserInterface/TestSceneContextMenu.cs

@@ -6,6 +6,7 @@
 using System;
 using System.Linq;
 using NUnit.Framework;
+using osu.Framework.Extensions.EnumExtensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Cursor;
@@ -199,14 +200,14 @@ public void TestMenuNotOnScreenWhenTargetSignificantlyOffScreen(Anchor anchor)
             {
                 box.Anchor = anchor;
 
-                if (anchor.HasFlag(Anchor.x0))
+                if (anchor.HasFlagFast(Anchor.x0))
                     box.X -= contextMenuContainer.CurrentMenu.DrawWidth + 10;
-                else if (anchor.HasFlag(Anchor.x2))
+                else if (anchor.HasFlagFast(Anchor.x2))
                     box.X += 10;
 
-                if (anchor.HasFlag(Anchor.y0))
+                if (anchor.HasFlagFast(Anchor.y0))
                     box.Y -= contextMenuContainer.CurrentMenu.DrawHeight + 10;
-                else if (anchor.HasFlag(Anchor.y2))
+                else if (anchor.HasFlagFast(Anchor.y2))
                     box.Y += 10;
             });
 

osu.Framework/Audio/Mixing/Bass/BassAudioMixer.cs

@@ -7,6 +7,7 @@
 using System.Runtime.InteropServices;
 using ManagedBass;
 using ManagedBass.Mix;
+using osu.Framework.Extensions.EnumExtensions;
 using osu.Framework.Statistics;
 
 namespace osu.Framework.Audio.Mixing.Bass
@@ -158,7 +159,7 @@ public PlaybackState ChannelIsActive(IBassAudioChannel channel)
 
             // The channel is always in a playing state unless stopped or stalled as it's a decoding channel. Retrieve the true playing state from the mixer channel.
             if (state == PlaybackState.Playing)
-                state = BassMix.ChannelFlags(channel.Handle, BassFlags.Default, BassFlags.Default).HasFlag(BassFlags.MixerChanPause) ? PlaybackState.Paused : state;
+                state = BassMix.ChannelFlags(channel.Handle, BassFlags.Default, BassFlags.Default).HasFlagFast(BassFlags.MixerChanPause) ? PlaybackState.Paused : state;
 
             return state;
         }

osu.Framework/Extensions/AnchorExtensions.cs

@@ -2,6 +2,7 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
+using osu.Framework.Extensions.EnumExtensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Primitives;
 using osuTK;
@@ -21,9 +22,9 @@ public static Anchor Opposite(this Anchor anchor)
             if (anchor == Anchor.Custom)
                 throw new ArgumentException($"{nameof(Anchor.Custom)} is not supported.", nameof(anchor));
 
-            if (anchor.HasFlag(Anchor.x0) || anchor.HasFlag(Anchor.x2))
+            if (anchor.HasFlagFast(Anchor.x0) || anchor.HasFlagFast(Anchor.x2))
                 anchor ^= Anchor.x0 | Anchor.x2;
-            if (anchor.HasFlag(Anchor.y0) || anchor.HasFlag(Anchor.y2))
+            if (anchor.HasFlagFast(Anchor.y0) || anchor.HasFlagFast(Anchor.y2))
                 anchor ^= Anchor.y0 | Anchor.y2;
 
             return anchor;
@@ -39,18 +40,18 @@ public static Vector2 PositionOnQuad(this Anchor anchor, Quad quad)
 
             Vector2 position = new Vector2();
 
-            if (anchor.HasFlag(Anchor.x0))
+            if (anchor.HasFlagFast(Anchor.x0))
                 position.X = quad.TopLeft.X;
-            else if (anchor.HasFlag(Anchor.x1))
+            else if (anchor.HasFlagFast(Anchor.x1))
                 position.X = quad.Centre.X;
-            else if (anchor.HasFlag(Anchor.x2))
+            else if (anchor.HasFlagFast(Anchor.x2))
                 position.X = quad.BottomRight.X;
 
-            if (anchor.HasFlag(Anchor.y0))
+            if (anchor.HasFlagFast(Anchor.y0))
                 position.Y = quad.TopLeft.Y;
-            else if (anchor.HasFlag(Anchor.y1))
+            else if (anchor.HasFlagFast(Anchor.y1))
                 position.Y = quad.Centre.Y;
-            else if (anchor.HasFlag(Anchor.y2))
+            else if (anchor.HasFlagFast(Anchor.y2))
                 position.Y = quad.BottomRight.Y;
 
             return position;

osu.Framework/Extensions/EnumExtensions/EnumExtensions.cs

@@ -6,6 +6,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Runtime.CompilerServices;
 using osu.Framework.Extensions.ObjectExtensions;
 using osu.Framework.Utils;
 
@@ -54,5 +55,48 @@ public static IEnumerable<T> GetValuesInOrder<T>(this IEnumerable<T> items)
                 throw new ArgumentException($"Not all values of {typeof(T)} have {nameof(OrderAttribute)} specified.");
             });
         }
+
+#pragma warning disable RS0030 // (banned API)
+        /// <summary>
+        /// A fast alternative functionally equivalent to <see cref="Enum.HasFlag"/>, eliminating boxing in all scenarios.
+        /// </summary>
+        /// <param name="enumValue">The enum to check.</param>
+        /// <param name="flag">The flag to check for.</param>
+#pragma warning restore RS0030
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static unsafe bool HasFlagFast<T>(this T enumValue, T flag) where T : unmanaged, Enum
+        {
+            // Note: Using a switch statement would eliminate inlining.
+
+            if (sizeof(T) == 1)
+            {
+                byte value1 = Unsafe.As<T, byte>(ref enumValue);
+                byte value2 = Unsafe.As<T, byte>(ref flag);
+                return (value1 & value2) == value2;
+            }
+
+            if (sizeof(T) == 2)
+            {
+                short value1 = Unsafe.As<T, short>(ref enumValue);
+                short value2 = Unsafe.As<T, short>(ref flag);
+                return (value1 & value2) == value2;
+            }
+
+            if (sizeof(T) == 4)
+            {
+                int value1 = Unsafe.As<T, int>(ref enumValue);
+                int value2 = Unsafe.As<T, int>(ref flag);
+                return (value1 & value2) == value2;
+            }
+
+            if (sizeof(T) == 8)
+            {
+                long value1 = Unsafe.As<T, long>(ref enumValue);
+                long value2 = Unsafe.As<T, long>(ref flag);
+                return (value1 & value2) == value2;
+            }
+
+            throw new ArgumentException($"Invalid enum type provided: {typeof(T)}.");
+        }
     }
 }

osu.Framework/Extensions/TaskExtensions.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Threading;
 using System.Threading.Tasks;
+using osu.Framework.Extensions.EnumExtensions;
 
 namespace osu.Framework.Extensions
 {
@@ -42,7 +43,7 @@ public static T GetResultSafely<T>(this Task<T> task)
         private static bool isWaitingValid(Task task)
         {
             // In the case the task has been started with the LongRunning flag, it will not be in the TPL thread pool and we can allow waiting regardless.
-            if (task.CreationOptions.HasFlag(TaskCreationOptions.LongRunning))
+            if (task.CreationOptions.HasFlagFast(TaskCreationOptions.LongRunning))
                 return true;
 
             // Otherwise only allow waiting from a non-TPL thread pool thread.

osu.Framework/Graphics/Containers/AudioContainer.cs

@@ -5,6 +5,7 @@
 using System.Collections;
 using System.Collections.Generic;
 using osu.Framework.Audio;
+using osu.Framework.Extensions.EnumExtensions;
 using osu.Framework.Graphics.Audio;
 using osu.Framework.Graphics.Effects;
 using osuTK;
@@ -40,8 +41,8 @@ public override Vector2 Size
             set
             {
                 base.Size = new Vector2(
-                    RelativeSizeAxes.HasFlag(Axes.X) ? 1 : value.X,
-                    RelativeSizeAxes.HasFlag(Axes.Y) ? 1 : value.Y);
+                    RelativeSizeAxes.HasFlagFast(Axes.X) ? 1 : value.X,
+                    RelativeSizeAxes.HasFlagFast(Axes.Y) ? 1 : value.Y);
 
                 container.Size = value;
             }

osu.Framework/Graphics/Containers/CompositeDrawable.cs

@@ -23,6 +23,7 @@
 using System.Threading.Tasks;
 using JetBrains.Annotations;
 using osu.Framework.Development;
+using osu.Framework.Extensions.EnumExtensions;
 using osu.Framework.Extensions.ExceptionExtensions;
 using osu.Framework.Graphics.Effects;
 using osu.Framework.Graphics.Primitives;
@@ -722,9 +723,9 @@ protected virtual bool CheckChildrenLife()
             {
                 var state = checkChildLife(internalChildren[i]);
 
-                anyAliveChanged |= state.HasFlag(ChildLifeStateChange.MadeAlive) || state.HasFlag(ChildLifeStateChange.MadeDead);
+                anyAliveChanged |= state.HasFlagFast(ChildLifeStateChange.MadeAlive) || state.HasFlagFast(ChildLifeStateChange.MadeDead);
 
-                if (state.HasFlag(ChildLifeStateChange.Removed))
+                if (state.HasFlagFast(ChildLifeStateChange.Removed))
                     i--;
             }
 
@@ -1839,7 +1840,7 @@ public override float Width
         {
             get
             {
-                if (!isComputingChildrenSizeDependencies && AutoSizeAxes.HasFlag(Axes.X))
+                if (!isComputingChildrenSizeDependencies && AutoSizeAxes.HasFlagFast(Axes.X))
                     updateChildrenSizeDependencies();
                 return base.Width;
             }
@@ -1857,7 +1858,7 @@ public override float Height
         {
             get
             {
-                if (!isComputingChildrenSizeDependencies && AutoSizeAxes.HasFlag(Axes.Y))
+                if (!isComputingChildrenSizeDependencies && AutoSizeAxes.HasFlagFast(Axes.Y))
                     updateChildrenSizeDependencies();
                 return base.Height;
             }
@@ -1913,16 +1914,16 @@ private Vector2 computeAutoSize()
 
                     Vector2 cBound = c.RequiredParentSizeToFit;
 
-                    if (!c.BypassAutoSizeAxes.HasFlag(Axes.X))
+                    if (!c.BypassAutoSizeAxes.HasFlagFast(Axes.X))
                         maxBoundSize.X = Math.Max(maxBoundSize.X, cBound.X);
 
-                    if (!c.BypassAutoSizeAxes.HasFlag(Axes.Y))
+                    if (!c.BypassAutoSizeAxes.HasFlagFast(Axes.Y))
                         maxBoundSize.Y = Math.Max(maxBoundSize.Y, cBound.Y);
                 }
 
-                if (!AutoSizeAxes.HasFlag(Axes.X))
+                if (!AutoSizeAxes.HasFlagFast(Axes.X))
                     maxBoundSize.X = DrawSize.X;
-                if (!AutoSizeAxes.HasFlag(Axes.Y))
+                if (!AutoSizeAxes.HasFlagFast(Axes.Y))
                     maxBoundSize.Y = DrawSize.Y;
 
                 return new Vector2(maxBoundSize.X, maxBoundSize.Y);
@@ -1942,8 +1943,8 @@ private void updateAutoSize()
             Vector2 b = computeAutoSize() + Padding.Total;
 
             autoSizeResizeTo(new Vector2(
-                AutoSizeAxes.HasFlag(Axes.X) ? b.X : base.Width,
-                AutoSizeAxes.HasFlag(Axes.Y) ? b.Y : base.Height
+                AutoSizeAxes.HasFlagFast(Axes.X) ? b.X : base.Width,
+                AutoSizeAxes.HasFlagFast(Axes.Y) ? b.Y : base.Height
             ), AutoSizeDuration, AutoSizeEasing);
 
             //note that this is called before autoSize becomes valid. may be something to consider down the line.

osu.Framework/Graphics/Containers/ContainerExtensions.cs

@@ -4,6 +4,7 @@
 using osuTK;
 using System;
 using System.Collections.Generic;
+using osu.Framework.Extensions.EnumExtensions;
 
 namespace osu.Framework.Graphics.Containers
 {
@@ -41,13 +42,13 @@ public static TContainer Wrap<TContainer, TChild>(this TContainer container, TCh
 
             // For anchor/origin positioning to be preserved correctly,
             // relatively sized axes must be lifted to the wrapping container.
-            if (container.RelativeSizeAxes.HasFlag(Axes.X))
+            if (container.RelativeSizeAxes.HasFlagFast(Axes.X))
             {
                 container.Width = drawable.Width;
                 drawable.Width = 1;
             }
 
-            if (container.RelativeSizeAxes.HasFlag(Axes.Y))
+            if (container.RelativeSizeAxes.HasFlagFast(Axes.Y))
             {
                 container.Height = drawable.Height;
                 drawable.Height = 1;