osu-lazer/osu.Game/Graphics/UserInterface/Hotkey.cs

// 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 System.Collections;
using System.Collections.Generic;
using System.Linq;
using osu.Framework.Input;
using osu.Framework.Input.Bindings;
using osu.Framework.Platform;
using osu.Game.Input;
using osu.Game.Input.Bindings;

namespace osu.Game.Graphics.UserInterface
{
    public readonly record struct Hotkey
    {
        public KeyCombination[]? KeyCombinations { get; init; }
        public GlobalAction? GlobalAction { get; init; }
        public PlatformAction? PlatformAction { get; init; }

        public Hotkey(params KeyCombination[] keyCombinations)
        {
            KeyCombinations = keyCombinations;
        }

        public Hotkey(GlobalAction globalAction)
        {
            GlobalAction = globalAction;
        }

        public Hotkey(PlatformAction platformAction)
        {
            PlatformAction = platformAction;
        }

        public IEnumerable<string> ResolveKeyCombination(ReadableKeyCombinationProvider keyCombinationProvider, RealmKeyBindingStore keyBindingStore, GameHost gameHost)
        {
            var result = new List<string>();

            if (KeyCombinations != null)
            {
                result.AddRange(KeyCombinations.Select(keyCombinationProvider.GetReadableString));
            }

            if (GlobalAction != null)
            {
                result.AddRange(keyBindingStore.GetReadableKeyCombinationsFor(GlobalAction.Value));
            }

            if (PlatformAction != null)
            {
                var action = PlatformAction.Value;
                var bindings = gameHost.PlatformKeyBindings.Where(kb => (PlatformAction)kb.Action == action);
                result.AddRange(bindings.Select(b => keyCombinationProvider.GetReadableString(b.KeyCombination)));
            }

            return result;
        }

        public bool Equals(Hotkey other)
        {
            if (KeyCombinations == null && other.KeyCombinations != null)
                return false;

            if (KeyCombinations != null && other.KeyCombinations == null)
                return false;

            bool result = (KeyCombinations == null && other.KeyCombinations == null) || KeyCombinations!.SequenceEqual(other.KeyCombinations!);
            result &= GlobalAction == other.GlobalAction;
            result &= PlatformAction == other.PlatformAction;
            return result;
        }

        public override int GetHashCode()
        {
            return HashCode.Combine(StructuralComparisons.StructuralEqualityComparer.GetHashCode(KeyCombinations ?? []), GlobalAction, PlatformAction);
        }
    }
}