// 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.Allocation; using osu.Framework.Input.Bindings; using osu.Game.Database; using osu.Game.Rulesets; using Realms; namespace osu.Game.Input.Bindings { /// /// A KeyBindingInputManager with a database backing for custom overrides. /// /// The type of the custom action. public class DatabasedKeyBindingContainer : KeyBindingContainer where T : struct { private readonly RulesetInfo ruleset; private readonly int? variant; private IDisposable realmSubscription; private IQueryable realmKeyBindings; [Resolved] private RealmKeyBindingStore store { get; set; } [Resolved] private RealmContextFactory realmFactory { get; set; } public override IEnumerable DefaultKeyBindings => ruleset.CreateInstance().GetDefaultKeyBindings(variant ?? 0); /// /// Create a new instance. /// /// A reference to identify the current . Used to lookup mappings. Null for global mappings. /// An optional variant for the specified . Used when a ruleset has more than one possible keyboard layouts. /// Specify how to deal with multiple matches of s and s. /// Specify how to deal with exact matches. public DatabasedKeyBindingContainer(RulesetInfo ruleset = null, int? variant = null, SimultaneousBindingMode simultaneousMode = SimultaneousBindingMode.None, KeyCombinationMatchingMode matchingMode = KeyCombinationMatchingMode.Any) : base(simultaneousMode, matchingMode) { this.ruleset = ruleset; this.variant = variant; if (ruleset != null && variant == null) throw new InvalidOperationException($"{nameof(variant)} can not be null when a non-null {nameof(ruleset)} is provided."); } protected override void LoadComplete() { if (ruleset == null || ruleset.ID.HasValue) { var rulesetId = ruleset?.ID; realmKeyBindings = realmFactory.Context.All() .Where(b => b.RulesetID == rulesetId && b.Variant == variant); realmSubscription = realmKeyBindings .SubscribeForNotifications((sender, changes, error) => { // first subscription ignored as we are handling this in LoadComplete. if (changes == null) return; ReloadMappings(); }); } base.LoadComplete(); } protected override void ReloadMappings() { if (realmKeyBindings != null) KeyBindings = realmKeyBindings.Detach(); else base.ReloadMappings(); } protected override void Dispose(bool isDisposing) { base.Dispose(isDisposing); realmSubscription?.Dispose(); } } }