6f6fb5b393
Allows the Settings > Hotkeys screen to be localised, including hotkey decriptions, groups and contexts. The hotkey names are exposed to localisation via KeycodeExts. Hotkey modifiers are similarly exposed via ModifersExts. The Settings > Input screen has a Zoom Modifier dropdown, which shows the localised modifier name. The --check-yaml utility command is taught to recognise all hotkey translation, so it can validate their usage.
109 lines
2.6 KiB
C#
109 lines
2.6 KiB
C#
#region Copyright & License Information
|
|
/*
|
|
* Copyright (c) The OpenRA Developers and Contributors
|
|
* This file is part of OpenRA, which is free software. It is made
|
|
* available to you under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation, either version 3 of
|
|
* the License, or (at your option) any later version. For more
|
|
* information, see COPYING.
|
|
*/
|
|
#endregion
|
|
|
|
using System;
|
|
|
|
namespace OpenRA
|
|
{
|
|
public readonly struct Hotkey : IEquatable<Hotkey>
|
|
{
|
|
public static Hotkey Invalid = new(Keycode.UNKNOWN, Modifiers.None);
|
|
public bool IsValid()
|
|
{
|
|
return Key != Keycode.UNKNOWN;
|
|
}
|
|
|
|
public readonly Keycode Key;
|
|
public readonly Modifiers Modifiers;
|
|
|
|
public static bool TryParse(string s, out Hotkey result)
|
|
{
|
|
result = Invalid;
|
|
if (string.IsNullOrWhiteSpace(s))
|
|
return false;
|
|
|
|
var parts = s.Split(' ');
|
|
|
|
if (!Enum<Keycode>.TryParse(parts[0], true, out var key))
|
|
{
|
|
if (!int.TryParse(parts[0], out var c))
|
|
return false;
|
|
key = (Keycode)c;
|
|
}
|
|
|
|
var mods = Modifiers.None;
|
|
if (parts.Length >= 2)
|
|
{
|
|
var modString = s[s.IndexOf(' ')..];
|
|
if (!Enum<Modifiers>.TryParse(modString, true, out mods))
|
|
return false;
|
|
}
|
|
|
|
result = new Hotkey(key, mods);
|
|
return true;
|
|
}
|
|
|
|
public static Hotkey FromKeyInput(KeyInput ki)
|
|
{
|
|
return new Hotkey(ki.Key, ki.Modifiers);
|
|
}
|
|
|
|
public Hotkey(Keycode virtKey, Modifiers mod)
|
|
{
|
|
Key = virtKey;
|
|
Modifiers = mod;
|
|
}
|
|
|
|
public static bool operator !=(Hotkey a, Hotkey b) { return !(a == b); }
|
|
public static bool operator ==(Hotkey a, Hotkey b)
|
|
{
|
|
// Unknown keys are never equal
|
|
if (a.Key == Keycode.UNKNOWN)
|
|
return false;
|
|
|
|
return a.Key == b.Key && a.Modifiers == b.Modifiers;
|
|
}
|
|
|
|
public override int GetHashCode() { return Key.GetHashCode() ^ Modifiers.GetHashCode(); }
|
|
|
|
public bool Equals(Hotkey other)
|
|
{
|
|
return other == this;
|
|
}
|
|
|
|
public override bool Equals(object obj)
|
|
{
|
|
return obj is Hotkey o && (Hotkey?)o == this;
|
|
}
|
|
|
|
public override string ToString() { return $"{Key} {Modifiers:F}"; }
|
|
|
|
public string DisplayString()
|
|
{
|
|
var ret = KeycodeExts.DisplayString(Key);
|
|
|
|
if (Modifiers.HasModifier(Modifiers.Shift))
|
|
ret = $"{ModifiersExts.DisplayString(Modifiers.Shift)} + {ret}";
|
|
|
|
if (Modifiers.HasModifier(Modifiers.Alt))
|
|
ret = $"{ModifiersExts.DisplayString(Modifiers.Alt)} + {ret}";
|
|
|
|
if (Modifiers.HasModifier(Modifiers.Ctrl))
|
|
ret = $"{ModifiersExts.DisplayString(Modifiers.Ctrl)} + {ret}";
|
|
|
|
if (Modifiers.HasModifier(Modifiers.Meta))
|
|
ret = $"{ModifiersExts.DisplayString(Modifiers.Meta)} + {ret}";
|
|
|
|
return ret;
|
|
}
|
|
}
|
|
}
|