Ellpeck/MLEM
1
0
Fork 0
mirror of https://github.com/Ellpeck/MLEM.git synced 2024-11-22 12:58:33 +01:00
Code Issues Projects Releases Wiki Activity

Made fields and methods in StaticJsonConverter protected to allow extending it

Browse source
This commit is contained in:
Ell 2024-10-20 12:31:31 +02:00
parent 3bc5c7f18c
commit 1cfdedfc80
2 changed files with 41 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -31,6 +31,10 @@ Additions
Fixes Fixes
- Fixed tooltips not being bounded correctly for viewports that don't start at the origin - Fixed tooltips not being bounded correctly for viewports that don't start at the origin
### MLEM.Data
Improvements
- Made fields and methods in StaticJsonConverter protected to allow extending it
## 7.1.1 ## 7.1.1
### MLEM ### MLEM

49
MLEM.Data/Json/StaticJsonConverter.cs
View file

@ -15,19 +15,30 @@ namespace MLEM.Data.Json {
/// <typeparam name="T">The type of the object to convert</typeparam> /// <typeparam name="T">The type of the object to convert</typeparam>
public class StaticJsonConverter<T> : JsonConverter<T> { public class StaticJsonConverter<T> : JsonConverter<T> {
private readonly Dictionary<string, T> entries; /// <summary>
private readonly Dictionary<T, string> inverse; /// The entries, or registry, that this static json converter uses.
private readonly bool throwOnRead; /// </summary>
protected readonly Dictionary<string, T> Entries;
/// <summary>
/// The inverse of this static json converter's <see cref="Entries"/>, mapping the values to their respective keys.
/// Note that this dictionary is only created once and is not automatically updated should the <see cref="Entries"/> be modified.
/// </summary>
protected readonly Dictionary<T, string> Inverse;
/// <summary>
/// Whether to throw a <see cref="KeyNotFoundException"/> in <see cref="ReadJson"/> if a key is missing, or throw a <see cref="JsonSerializationException"/> if a stored json value is not a string.
/// If this is <see langword="false"/>, <see cref="ReadJson"/> returns <see langword="default"/> instead.
/// </summary>
protected readonly bool ThrowOnRead;
/// <summary> /// <summary>
/// Creates a new static json converter using the given underlying <see cref="Dictionary{T,T}"/>. /// Creates a new static json converter using the given underlying <see cref="Dictionary{T,T}"/>.
/// </summary> /// </summary>
/// <param name="entries">The dictionary to use</param> /// <param name="entries">The entries, or registry, that this static json converter uses.</param>
/// <param name="throwOnRead">Whether to throw a <see cref="KeyNotFoundException"/> in <see cref="ReadJson"/> if a key is missing, or throw a <see cref="JsonSerializationException"/> if a stored json value is not a string. If this is <see langword="false"/>, <see cref="ReadJson"/> returns <see langword="default"/> instead.</param> /// <param name="throwOnRead">Whether to throw a <see cref="KeyNotFoundException"/> in <see cref="ReadJson"/> if a key is missing, or throw a <see cref="JsonSerializationException"/> if a stored json value is not a string. If this is <see langword="false"/>, <see cref="ReadJson"/> returns <see langword="default"/> instead.</param>
public StaticJsonConverter(Dictionary<string, T> entries, bool throwOnRead = false) { public StaticJsonConverter(Dictionary<string, T> entries, bool throwOnRead = false) {
this.entries = entries; this.Entries = entries;
this.inverse = StaticJsonConverter<T>.CreateInverse(entries); this.Inverse = StaticJsonConverter<T>.CreateInverse(entries);
this.throwOnRead = throwOnRead; this.ThrowOnRead = throwOnRead;
} }
/// <summary> /// <summary>
@ -62,7 +73,7 @@ namespace MLEM.Data.Json {
writer.WriteNull(); writer.WriteNull();
return; return;
} }
if (!this.inverse.TryGetValue(value, out var key)) if (!this.Inverse.TryGetValue(value, out var key))
throw new KeyNotFoundException($"Cannot write {value} that is not a registered entry"); throw new KeyNotFoundException($"Cannot write {value} that is not a registered entry");
writer.WriteValue(key); writer.WriteValue(key);
} }
@ -78,16 +89,24 @@ namespace MLEM.Data.Json {
if (reader.Value == null) if (reader.Value == null)
return default; return default;
if (reader.TokenType != JsonToken.String) { if (reader.TokenType != JsonToken.String) {
if (this.throwOnRead) if (this.ThrowOnRead)
throw new JsonSerializationException($"Expected a string value for {reader.Value}, got a {reader.TokenType}"); throw new JsonSerializationException($"Expected a string value for {reader.Value}, got a {reader.TokenType}");
return default; return default;
} }
if (!this.entries.TryGetValue((string) reader.Value, out var ret) && this.throwOnRead) if (!this.Entries.TryGetValue((string) reader.Value, out var ret) && this.ThrowOnRead)
throw new KeyNotFoundException($"Could not find registered entry for {reader.Value}"); throw new KeyNotFoundException($"Could not find registered entry for {reader.Value}");
return ret; return ret;
} }
private static Dictionary<string, T> GetEntries( /// <summary>
/// Returns the entries, or registry, that this static json converter should use, using reflection to find the passed <paramref name="memberName"/> in the passed <paramref name="type"/>.
/// </summary>
/// <param name="type">The type to find the entries in.</param>
/// <param name="memberName">The name of the field or property that the entries are in within the given <paramref name="type"/>.</param>
/// <returns>The found property or field's value.</returns>
/// <exception cref="ArgumentException">Thrown if there is no property or field with the <paramref name="memberName"/> in the given <paramref name="type"/>.</exception>
/// <exception cref="InvalidCastException">Thrown if the value of the <paramref name="memberName"/> is not of the expected type.</exception>
protected static Dictionary<string, T> GetEntries(
#if NET6_0_OR_GREATER #if NET6_0_OR_GREATER
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.NonPublicProperties | DynamicallyAccessedMemberTypes.PublicFields | DynamicallyAccessedMemberTypes.NonPublicFields)] [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.NonPublicProperties | DynamicallyAccessedMemberTypes.PublicFields | DynamicallyAccessedMemberTypes.NonPublicFields)]
#endif #endif
@ -99,7 +118,13 @@ namespace MLEM.Data.Json {
return value as Dictionary<string, T> ?? throw new InvalidCastException($"{value} is not of expected type {typeof(T)}"); return value as Dictionary<string, T> ?? throw new InvalidCastException($"{value} is not of expected type {typeof(T)}");
} }
private static Dictionary<T, string> CreateInverse(Dictionary<string, T> entries) { /// <summary>
/// Creates the inverse version of the passed <paramref name="entries"/>, mapping the values to their keys, and throws an exception if there are any duplicate values.
/// </summary>
/// <param name="entries">The entries to create an inverse of.</param>
/// <returns>The inverse of the given <paramref name="entries"/>, mapping the values to their keys.</returns>
/// <exception cref="ArgumentException">Thrown if the <paramref name="entries"/> contains duplicate values, making it impossible to create a valid inverse.</exception>
protected static Dictionary<T, string> CreateInverse(Dictionary<string, T> entries) {
var ret = new Dictionary<T, string>(); var ret = new Dictionary<T, string>();
foreach (var entry in entries) { foreach (var entry in entries) {
if (ret.ContainsKey(entry.Value)) if (ret.ContainsKey(entry.Value))