gui-cs.Terminal.Gui/Terminal.Gui/Configuration/KeyJsonConverter.cs

using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Text.Json.Serialization;

namespace Terminal.Gui {
	/// <summary>
	/// Json converter for the <see cref="Key"/> class.
	/// </summary>
	public class KeyJsonConverter : JsonConverter<Key> {
		/// <inheritdoc/>
		public override Key Read (ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
		{
			if (reader.TokenType == JsonTokenType.StartObject) {
				Key key = Key.Unknown;
				Dictionary<string, Key> modifierDict = new Dictionary<string, Key> (comparer: StringComparer.InvariantCultureIgnoreCase) {
					{ "Shift", Key.ShiftMask },
					{ "Ctrl", Key.CtrlMask },
					{ "Alt", Key.AltMask }
				};

				List<Key> modifiers = new List<Key> ();

				while (reader.Read ()) {
					if (reader.TokenType == JsonTokenType.EndObject) {
						break;
					}

					if (reader.TokenType == JsonTokenType.PropertyName) {
						string propertyName = reader.GetString ();
						reader.Read ();

						switch (propertyName.ToLowerInvariant ()) {
						case "key":
							if (reader.TokenType == JsonTokenType.String) {
								if (Enum.TryParse (reader.GetString (), false, out key)) {
									break;
								}
								
								// The enum uses "D0..D9" for the number keys
								if (Enum.TryParse (reader.GetString ().TrimStart ('D', 'd'), false, out key)) {
									break;
								}

								if (key == Key.Unknown || key == Key.Null) {
									throw new JsonException ($"The value \"{reader.GetString ()}\" is not a valid Key.");
								}

							} else if (reader.TokenType == JsonTokenType.Number) {
								try {
									key = (Key)reader.GetInt32 ();
								} catch (InvalidOperationException ioe) {
									throw new JsonException ($"Error parsing Key value: {ioe.Message}", ioe);
								} catch (FormatException ioe) {
									throw new JsonException ($"Error parsing Key value: {ioe.Message}", ioe);
								}
								break;
							}
							break;

						case "modifiers":
							if (reader.TokenType == JsonTokenType.StartArray) {
								while (reader.Read ()) {
									if (reader.TokenType == JsonTokenType.EndArray) {
										break;
									}
									var mod = reader.GetString ();
									try {
										modifiers.Add (modifierDict [mod]);
									} catch (KeyNotFoundException e) {
										throw new JsonException ($"The value \"{mod}\" is not a valid modifier.", e);
									}
								}
							} else {
								throw new JsonException ($"Expected an array of modifiers, but got \"{reader.TokenType}\".");
							}
							break;

						default:
							throw new JsonException ($"Unexpected Key property \"{propertyName}\".");
						}
					}
				}

				foreach (var modifier in modifiers) {
					key |= modifier;
				}

				return key;
			}
			throw new JsonException ($"Unexpected StartObject token when parsing Key: {reader.TokenType}.");
		}

		/// <inheritdoc/>
		public override void Write (Utf8JsonWriter writer, Key value, JsonSerializerOptions options)
		{
			writer.WriteStartObject ();

			var keyName = (value & ~Key.CtrlMask & ~Key.ShiftMask & ~Key.AltMask).ToString ();
			if (keyName != null) {
				writer.WriteString ("Key", keyName);
			} else {
				writer.WriteNumber ("Key", (uint)(value & ~Key.CtrlMask & ~Key.ShiftMask & ~Key.AltMask));
			}

			Dictionary<string, Key> modifierDict = new Dictionary<string, Key>
			{
				{ "Shift", Key.ShiftMask },
				{ "Ctrl", Key.CtrlMask },
				{ "Alt", Key.AltMask }
			    };

			List<string> modifiers = new List<string> ();
			foreach (var pair in modifierDict) {
				if ((value & pair.Value) == pair.Value) {
					modifiers.Add (pair.Key);
				}
			}

			if (modifiers.Count > 0) {
				writer.WritePropertyName ("Modifiers");
				writer.WriteStartArray ();
				foreach (var modifier in modifiers) {
					writer.WriteStringValue (modifier);
				}
				writer.WriteEndArray ();
			}

			writer.WriteEndObject ();
		}
	}
}