// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. using System; using System.Collections.Generic; using System.Linq; using osu.Framework.Input.Bindings; using osu.Framework.Platform; using osu.Game.Database; using osu.Game.Input.Bindings; using osu.Game.Rulesets; namespace osu.Game.Input { public class KeyBindingStore : DatabaseBackedStore { public event Action KeyBindingChanged; /// /// Keys which should not be allowed for gameplay input purposes. /// private static readonly IEnumerable banned_keys = new[] { InputKey.MouseWheelDown, InputKey.MouseWheelLeft, InputKey.MouseWheelUp, InputKey.MouseWheelRight }; public KeyBindingStore(DatabaseContextFactory contextFactory, RulesetStore rulesets, Storage storage = null) : base(contextFactory, storage) { using (ContextFactory.GetForWrite()) { foreach (var info in rulesets.AvailableRulesets) { var ruleset = info.CreateInstance(); foreach (var variant in ruleset.AvailableVariants) insertDefaults(ruleset.GetDefaultKeyBindings(variant), info.ID, variant); } } } public void Register(KeyBindingContainer manager) => insertDefaults(manager.DefaultKeyBindings); /// /// Retrieve all user-defined key combinations (in a format that can be displayed) for a specific action. /// /// The action to lookup. /// A set of display strings for all the user's key configuration for the action. public IEnumerable GetReadableKeyCombinationsFor(GlobalAction globalAction) { foreach (var action in Query().Where(b => (GlobalAction)b.Action == globalAction)) { string str = action.KeyCombination.ReadableString(); // even if found, the readable string may be empty for an unbound action. if (str.Length > 0) yield return str; } } private void insertDefaults(IEnumerable defaults, int? rulesetId = null, int? variant = null) { using (var usage = ContextFactory.GetForWrite()) { // compare counts in database vs defaults foreach (var group in defaults.GroupBy(k => k.Action)) { int count = Query(rulesetId, variant).Count(k => (int)k.Action == (int)group.Key); int aimCount = group.Count(); if (aimCount <= count) continue; foreach (var insertable in group.Skip(count).Take(aimCount - count)) { // insert any defaults which are missing. usage.Context.DatabasedKeyBinding.Add(new DatabasedKeyBinding { KeyCombination = insertable.KeyCombination, Action = insertable.Action, RulesetID = rulesetId, Variant = variant }); // required to ensure stable insert order (https://github.com/dotnet/efcore/issues/11686) usage.Context.SaveChanges(); } } } } /// /// Retrieve s for a specified ruleset/variant content. /// /// The ruleset's internal ID. /// An optional variant. public List Query(int? rulesetId = null, int? variant = null) => ContextFactory.Get().DatabasedKeyBinding.Where(b => b.RulesetID == rulesetId && b.Variant == variant).ToList(); public void Update(KeyBinding keyBinding) { using (ContextFactory.GetForWrite()) { var dbKeyBinding = (DatabasedKeyBinding)keyBinding; if (dbKeyBinding.RulesetID != null && !CheckValidForGameplay(keyBinding.KeyCombination)) return; Refresh(ref dbKeyBinding); if (dbKeyBinding.KeyCombination.Equals(keyBinding.KeyCombination)) return; dbKeyBinding.KeyCombination = keyBinding.KeyCombination; } KeyBindingChanged?.Invoke(); } public static bool CheckValidForGameplay(KeyCombination combination) { foreach (var key in banned_keys) { if (combination.Keys.Contains(key)) return false; } return true; } } }