2021-01-07 13:35:15 +08:00
|
|
|
// 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.Collections.Generic;
|
|
|
|
using System.Linq;
|
2021-11-08 13:55:26 +08:00
|
|
|
using osu.Framework.Input;
|
2021-01-07 13:35:15 +08:00
|
|
|
using osu.Framework.Input.Bindings;
|
|
|
|
using osu.Game.Database;
|
|
|
|
using osu.Game.Input.Bindings;
|
|
|
|
using osu.Game.Rulesets;
|
2021-09-30 22:42:40 +08:00
|
|
|
using Realms;
|
2021-01-07 13:35:15 +08:00
|
|
|
|
2021-01-12 13:55:45 +08:00
|
|
|
#nullable enable
|
|
|
|
|
2021-01-07 13:35:15 +08:00
|
|
|
namespace osu.Game.Input
|
|
|
|
{
|
2021-01-13 17:13:30 +08:00
|
|
|
public class RealmKeyBindingStore
|
2021-01-07 13:35:15 +08:00
|
|
|
{
|
2022-01-24 18:59:58 +08:00
|
|
|
private readonly RealmAccess realm;
|
2021-11-08 17:24:37 +08:00
|
|
|
private readonly ReadableKeyCombinationProvider keyCombinationProvider;
|
2021-01-13 17:13:30 +08:00
|
|
|
|
2022-01-24 18:59:58 +08:00
|
|
|
public RealmKeyBindingStore(RealmAccess realm, ReadableKeyCombinationProvider keyCombinationProvider)
|
2021-01-07 13:35:15 +08:00
|
|
|
{
|
2022-01-24 18:59:58 +08:00
|
|
|
this.realm = realm;
|
2021-11-08 17:24:37 +08:00
|
|
|
this.keyCombinationProvider = keyCombinationProvider;
|
2021-01-07 13:35:15 +08:00
|
|
|
}
|
|
|
|
|
2021-01-07 14:51:16 +08:00
|
|
|
/// <summary>
|
|
|
|
/// Retrieve all user-defined key combinations (in a format that can be displayed) for a specific action.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="globalAction">The action to lookup.</param>
|
|
|
|
/// <returns>A set of display strings for all the user's key configuration for the action.</returns>
|
2021-06-18 16:01:51 +08:00
|
|
|
public IReadOnlyList<string> GetReadableKeyCombinationsFor(GlobalAction globalAction)
|
2021-01-07 14:51:16 +08:00
|
|
|
{
|
2021-06-18 16:01:51 +08:00
|
|
|
List<string> combinations = new List<string>();
|
2021-01-07 14:51:16 +08:00
|
|
|
|
2022-01-24 18:59:58 +08:00
|
|
|
realm.Run(context =>
|
2021-06-18 16:01:51 +08:00
|
|
|
{
|
2021-11-22 17:34:04 +08:00
|
|
|
foreach (var action in context.All<RealmKeyBinding>().Where(b => string.IsNullOrEmpty(b.RulesetName) && (GlobalAction)b.ActionInt == globalAction))
|
2021-06-18 16:01:51 +08:00
|
|
|
{
|
2021-11-08 17:24:37 +08:00
|
|
|
string str = keyCombinationProvider.GetReadableString(action.KeyCombination);
|
2021-06-18 16:01:51 +08:00
|
|
|
|
|
|
|
// even if found, the readable string may be empty for an unbound action.
|
|
|
|
if (str.Length > 0)
|
|
|
|
combinations.Add(str);
|
|
|
|
}
|
2022-01-21 16:08:20 +08:00
|
|
|
});
|
2021-06-18 16:01:51 +08:00
|
|
|
|
|
|
|
return combinations;
|
2021-01-07 14:51:16 +08:00
|
|
|
}
|
|
|
|
|
2021-01-11 15:18:25 +08:00
|
|
|
/// <summary>
|
2021-09-07 14:19:23 +08:00
|
|
|
/// Register all defaults for this store.
|
2021-01-11 15:18:25 +08:00
|
|
|
/// </summary>
|
|
|
|
/// <param name="container">The container to populate defaults from.</param>
|
2021-09-07 14:19:23 +08:00
|
|
|
/// <param name="rulesets">The rulesets to populate defaults from.</param>
|
|
|
|
public void Register(KeyBindingContainer container, IEnumerable<RulesetInfo> rulesets)
|
2021-01-07 13:35:15 +08:00
|
|
|
{
|
2022-01-25 12:04:05 +08:00
|
|
|
realm.Run(r =>
|
2021-01-07 13:35:15 +08:00
|
|
|
{
|
2022-01-25 12:04:05 +08:00
|
|
|
using (var transaction = r.BeginWrite())
|
2022-01-21 16:08:20 +08:00
|
|
|
{
|
|
|
|
// intentionally flattened to a list rather than querying against the IQueryable, as nullable fields being queried against aren't indexed.
|
|
|
|
// this is much faster as a result.
|
2022-01-25 12:04:05 +08:00
|
|
|
var existingBindings = r.All<RealmKeyBinding>().ToList();
|
2021-09-07 14:19:23 +08:00
|
|
|
|
2022-01-25 12:04:05 +08:00
|
|
|
insertDefaults(r, existingBindings, container.DefaultKeyBindings);
|
2021-09-07 14:19:23 +08:00
|
|
|
|
2022-01-21 16:08:20 +08:00
|
|
|
foreach (var ruleset in rulesets)
|
|
|
|
{
|
|
|
|
var instance = ruleset.CreateInstance();
|
|
|
|
foreach (int variant in instance.AvailableVariants)
|
2022-01-25 12:04:05 +08:00
|
|
|
insertDefaults(r, existingBindings, instance.GetDefaultKeyBindings(variant), ruleset.ShortName, variant);
|
2022-01-21 16:08:20 +08:00
|
|
|
}
|
2021-01-14 15:13:10 +08:00
|
|
|
|
2022-01-21 16:08:20 +08:00
|
|
|
transaction.Commit();
|
|
|
|
}
|
|
|
|
});
|
2021-01-07 13:35:15 +08:00
|
|
|
}
|
2021-05-25 16:18:33 +08:00
|
|
|
|
2021-11-22 17:34:04 +08:00
|
|
|
private void insertDefaults(Realm realm, List<RealmKeyBinding> existingBindings, IEnumerable<IKeyBinding> defaults, string? rulesetName = null, int? variant = null)
|
2021-09-07 14:19:23 +08:00
|
|
|
{
|
|
|
|
// compare counts in database vs defaults for each action type.
|
|
|
|
foreach (var defaultsForAction in defaults.GroupBy(k => k.Action))
|
|
|
|
{
|
2021-12-13 14:26:49 +08:00
|
|
|
IEnumerable<RealmKeyBinding> existing = existingBindings.Where(k =>
|
|
|
|
k.RulesetName == rulesetName
|
|
|
|
&& k.Variant == variant
|
|
|
|
&& k.ActionInt == (int)defaultsForAction.Key);
|
2021-09-07 14:19:23 +08:00
|
|
|
|
2021-12-13 14:26:49 +08:00
|
|
|
int defaultsCount = defaultsForAction.Count();
|
|
|
|
int existingCount = existing.Count();
|
2021-09-07 14:19:23 +08:00
|
|
|
|
2021-12-13 14:26:49 +08:00
|
|
|
if (defaultsCount > existingCount)
|
2021-09-07 14:19:23 +08:00
|
|
|
{
|
2021-12-13 14:26:49 +08:00
|
|
|
// insert any defaults which are missing.
|
2022-01-20 16:18:53 +08:00
|
|
|
realm.Add(defaultsForAction.Skip(existingCount).Select(k => new RealmKeyBinding(k.Action, k.KeyCombination, rulesetName, variant)));
|
2021-12-13 14:26:49 +08:00
|
|
|
}
|
|
|
|
else if (defaultsCount < existingCount)
|
|
|
|
{
|
|
|
|
// generally this shouldn't happen, but if the user has more key bindings for an action than we expect,
|
|
|
|
// remove the last entries until the count matches for sanity.
|
|
|
|
foreach (var k in existing.TakeLast(existingCount - defaultsCount).ToArray())
|
|
|
|
{
|
|
|
|
realm.Remove(k);
|
|
|
|
|
|
|
|
// Remove from the local flattened/cached list so future lookups don't query now deleted rows.
|
|
|
|
existingBindings.Remove(k);
|
|
|
|
}
|
|
|
|
}
|
2021-09-07 14:19:23 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-05-25 16:18:33 +08:00
|
|
|
/// <summary>
|
|
|
|
/// Keys which should not be allowed for gameplay input purposes.
|
|
|
|
/// </summary>
|
|
|
|
private static readonly IEnumerable<InputKey> banned_keys = new[]
|
|
|
|
{
|
|
|
|
InputKey.MouseWheelDown,
|
|
|
|
InputKey.MouseWheelLeft,
|
|
|
|
InputKey.MouseWheelUp,
|
|
|
|
InputKey.MouseWheelRight
|
|
|
|
};
|
|
|
|
|
|
|
|
public static bool CheckValidForGameplay(KeyCombination combination)
|
|
|
|
{
|
|
|
|
foreach (var key in banned_keys)
|
|
|
|
{
|
|
|
|
if (combination.Keys.Contains(key))
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
2021-01-07 13:35:15 +08:00
|
|
|
}
|
|
|
|
}
|