// 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; #nullable enable namespace osu.Game.Input { public class RealmKeyBindingStore : RealmBackedStore { /// /// Fired whenever any key binding change occurs, across all rulesets and types. /// public event Action? KeyBindingChanged; public RealmKeyBindingStore(RealmContextFactory contextFactory, RulesetStore? rulesets, Storage? storage = null) : base(contextFactory, storage) { if (rulesets != null) { // populate defaults from rulesets. using (ContextFactory.GetForWrite()) { foreach (RulesetInfo info in rulesets.AvailableRulesets) { var ruleset = info.CreateInstance(); foreach (var variant in ruleset.AvailableVariants) insertDefaults(ruleset.GetDefaultKeyBindings(variant), info.ID, variant); } } } } /// /// 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 = ((IKeyBinding)action).KeyCombination.ReadableString(); // even if found, the readable string may be empty for an unbound action. if (str.Length > 0) yield return str; } } /// /// Register a new type of , adding default bindings from . /// /// The container to populate defaults from. public void Register(KeyBindingContainer container) => insertDefaults(container.DefaultKeyBindings); /// /// Retrieve all key bindings for the provided specification. /// /// An optional ruleset ID. If null, global bindings are returned. /// An optional ruleset variant. If null, the no-variant bindings are returned. /// A list of all key bindings found for the query, detached from the database. public List Query(int? rulesetId = null, int? variant = null) => query(rulesetId, variant).ToList(); /// /// Retrieve all key bindings for the provided action type. /// /// The action to lookup. /// The enum type of the action. /// A list of all key bindings found for the query, detached from the database. public List Query(T action) where T : Enum { int lookup = (int)(object)action; return query(null, null).Where(rkb => rkb.Action == lookup).ToList(); } /// /// Update the database mapping for the provided key binding. /// /// The key binding to update. Can be detached from the database. /// The modification to apply to the key binding. public void Update(IHasGuidPrimaryKey keyBinding, Action modification) { // the incoming instance could already be a live access object. Live? realmBinding = keyBinding as Live; using (var realm = ContextFactory.GetForWrite()) { if (realmBinding == null) { // the incoming instance could be a raw realm object. if (!(keyBinding is RealmKeyBinding rkb)) // if neither of the above cases succeeded, retrieve a realm object for further processing. rkb = realm.Context.Find(keyBinding.ID); realmBinding = new Live(rkb, ContextFactory); } realmBinding.PerformUpdate(modification); } KeyBindingChanged?.Invoke(); } 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 => 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.Add(new RealmKeyBinding { ID = Guid.NewGuid().ToString(), KeyCombination = insertable.KeyCombination.ToString(), Action = (int)insertable.Action, RulesetID = rulesetId, Variant = variant }); } } } } /// /// Retrieve live queryable s for a specified ruleset/variant content. /// /// An optional ruleset ID. If null, global bindings are returned. /// An optional ruleset variant. If null, the no-variant bindings are returned. private IQueryable query(int? rulesetId = null, int? variant = null) => ContextFactory.Get().All().Where(b => b.RulesetID == rulesetId && b.Variant == variant); } }