add JSON converters for crossplatform-incompatible types (#423)

4 files changed, 252 insertions, 1 deletions

diff --git a/src/SMAPI/Framework/Serialisation/ColorConverter.cs b/src/SMAPI/Framework/Serialisation/ColorConverter.cs
new file mode 100644
index 00000000..d29f73b8
--- /dev/null
+++ b/src/SMAPI/Framework/Serialisation/ColorConverter.cs
@@ -0,0 +1,82 @@
+using System;
+using Microsoft.Xna.Framework;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using StardewModdingAPI.Framework.Exceptions;
+
+namespace StardewModdingAPI.Framework.Serialisation
+{
+    /// <summary>Handles deserialisation of <see cref="Color"/> for crossplatform compatibility.</summary>
+    internal class ColorConverter : JsonConverter
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>Whether this converter can write JSON.</summary>
+        public override bool CanWrite => false;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Get whether this instance can convert the specified object type.</summary>
+        /// <param name="objectType">The object type.</param>
+        public override bool CanConvert(Type objectType)
+        {
+            return objectType == typeof(Color);
+        }
+
+        /// <summary>Reads the JSON representation of the object.</summary>
+        /// <param name="reader">The JSON reader.</param>
+        /// <param name="objectType">The object type.</param>
+        /// <param name="existingValue">The object being read.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+        {
+            //    Linux/Mac: { "B": 76, "G": 51, "R": 25, "A": 102 }
+            //    Windows:   "26, 51, 76, 102"
+            JToken token = JToken.Load(reader);
+            switch (token.Type)
+            {
+                case JTokenType.Object:
+                    {
+                        JObject obj = (JObject)token;
+                        int r = obj.Value<int>(nameof(Color.R));
+                        int g = obj.Value<int>(nameof(Color.G));
+                        int b = obj.Value<int>(nameof(Color.B));
+                        int a = obj.Value<int>(nameof(Color.A));
+                        return new Color(r, g, b, a);
+                    }
+
+                case JTokenType.String:
+                    {
+                        string str = token.Value<string>();
+                        if (string.IsNullOrWhiteSpace(str))
+                            return null;
+
+                        string[] parts = str.Split(',');
+                        if (parts.Length != 4)
+                            throw new SParseException($"Can't parse {typeof(Color).Name} from {token.Path}, invalid value '{str}'.");
+
+                        int r = Convert.ToInt32(parts[0]);
+                        int g = Convert.ToInt32(parts[1]);
+                        int b = Convert.ToInt32(parts[2]);
+                        int a = Convert.ToInt32(parts[3]);
+                        return new Color(r, g, b, a);
+                    }
+
+                default:
+                    throw new SParseException($"Can't parse {typeof(Point).Name} from {token.Path}, must be an object or string.");
+            }
+        }
+
+        /// <summary>Writes the JSON representation of the object.</summary>
+        /// <param name="writer">The JSON writer.</param>
+        /// <param name="value">The value.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+        {
+            throw new InvalidOperationException("This converter does not write JSON.");
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Serialisation/JsonHelper.cs b/src/SMAPI/Framework/Serialisation/JsonHelper.cs
index 7c4e3ee3..f66f9dfb 100644
--- a/src/SMAPI/Framework/Serialisation/JsonHelper.cs
+++ b/src/SMAPI/Framework/Serialisation/JsonHelper.cs
@@ -19,9 +19,15 @@ namespace StardewModdingAPI.Framework.Serialisation
             ObjectCreationHandling = ObjectCreationHandling.Replace, // avoid issue where default ICollection<T> values are duplicated each time the config is loaded
             Converters = new List<JsonConverter>
             {
+                // enums
                 new StringEnumConverter<Buttons>(),
                 new StringEnumConverter<Keys>(),
-                new StringEnumConverter<SButton>()
+                new StringEnumConverter<SButton>(),
+
+                // crossplatform compatibility
+                new ColorConverter(),
+                new PointConverter(),
+                new RectangleConverter()
             }
         };
 
diff --git a/src/SMAPI/Framework/Serialisation/PointConverter.cs b/src/SMAPI/Framework/Serialisation/PointConverter.cs
new file mode 100644
index 00000000..d35660be
--- /dev/null
+++ b/src/SMAPI/Framework/Serialisation/PointConverter.cs
@@ -0,0 +1,79 @@
+using System;
+using Microsoft.Xna.Framework;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using StardewModdingAPI.Framework.Exceptions;
+
+namespace StardewModdingAPI.Framework.Serialisation
+{
+    /// <summary>Handles deserialisation of <see cref="PointConverter"/> for crossplatform compatibility.</summary>
+    internal class PointConverter : JsonConverter
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>Whether this converter can write JSON.</summary>
+        public override bool CanWrite => false;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Get whether this instance can convert the specified object type.</summary>
+        /// <param name="objectType">The object type.</param>
+        public override bool CanConvert(Type objectType)
+        {
+            return objectType == typeof(Point);
+        }
+
+        /// <summary>Reads the JSON representation of the object.</summary>
+        /// <param name="reader">The JSON reader.</param>
+        /// <param name="objectType">The object type.</param>
+        /// <param name="existingValue">The object being read.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+        {
+            // point
+            //    Linux/Mac: { "X": 1, "Y": 2 }
+            //    Windows:   "1, 2"
+            JToken token = JToken.Load(reader);
+            switch (token.Type)
+            {
+                case JTokenType.Object:
+                    {
+                        JObject obj = (JObject)token;
+                        int x = obj.Value<int>(nameof(Point.X));
+                        int y = obj.Value<int>(nameof(Point.Y));
+                        return new Point(x, y);
+                    }
+
+                case JTokenType.String:
+                    {
+                        string str = token.Value<string>();
+                        if (string.IsNullOrWhiteSpace(str))
+                            return null;
+
+                        string[] parts = str.Split(',');
+                        if (parts.Length != 2)
+                            throw new SParseException($"Can't parse {typeof(Point).Name} from {token.Path}, invalid value '{str}'.");
+
+                        int x = Convert.ToInt32(parts[0]);
+                        int y = Convert.ToInt32(parts[1]);
+                        return new Point(x, y);
+                    }
+
+                default:
+                    throw new SParseException($"Can't parse {typeof(Point).Name} from {token.Path}, must be an object or string.");
+            }
+        }
+
+        /// <summary>Writes the JSON representation of the object.</summary>
+        /// <param name="writer">The JSON writer.</param>
+        /// <param name="value">The value.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+        {
+            throw new InvalidOperationException("This converter does not write JSON.");
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/Serialisation/RectangleConverter.cs b/src/SMAPI/Framework/Serialisation/RectangleConverter.cs
new file mode 100644
index 00000000..74df54e2
--- /dev/null
+++ b/src/SMAPI/Framework/Serialisation/RectangleConverter.cs
@@ -0,0 +1,84 @@
+using System;
+using System.Text.RegularExpressions;
+using Microsoft.Xna.Framework;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using StardewModdingAPI.Framework.Exceptions;
+
+namespace StardewModdingAPI.Framework.Serialisation
+{
+    /// <summary>Handles deserialisation of <see cref="Rectangle"/> for crossplatform compatibility.</summary>
+    internal class RectangleConverter : JsonConverter
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>Whether this converter can write JSON.</summary>
+        public override bool CanWrite => false;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Get whether this instance can convert the specified object type.</summary>
+        /// <param name="objectType">The object type.</param>
+        public override bool CanConvert(Type objectType)
+        {
+            return objectType == typeof(Rectangle);
+        }
+
+        /// <summary>Reads the JSON representation of the object.</summary>
+        /// <param name="reader">The JSON reader.</param>
+        /// <param name="objectType">The object type.</param>
+        /// <param name="existingValue">The object being read.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+        {
+            //    Linux/Mac: { "X": 1, "Y": 2, "Width": 3, "Height": 4 }
+            //    Windows:   "{X:1 Y:2 Width:3 Height:4}"
+            JToken token = JToken.Load(reader);
+            switch (token.Type)
+            {
+                case JTokenType.Object:
+                    {
+                        JObject obj = (JObject)token;
+                        int x = obj.Value<int>(nameof(Rectangle.X));
+                        int y = obj.Value<int>(nameof(Rectangle.Y));
+                        int width = obj.Value<int>(nameof(Rectangle.Width));
+                        int height = obj.Value<int>(nameof(Rectangle.Height));
+                        return new Rectangle(x, y, width, height);
+                    }
+
+                case JTokenType.String:
+                    {
+                        string str = token.Value<string>();
+                        if (string.IsNullOrWhiteSpace(str))
+                            return Rectangle.Empty;
+
+                        var match = Regex.Match(str, @"^\{X:(?<x>\d+) Y:(?<y>\d+) Width:(?<width>\d+) Height:(?<height>\d+)\}$");
+                        if (!match.Success)
+                            throw new SParseException($"Can't parse {typeof(Rectangle).Name} from {reader.Path}, invalid string format.");
+
+                        int x = Convert.ToInt32(match.Groups["x"].Value);
+                        int y = Convert.ToInt32(match.Groups["y"].Value);
+                        int width = Convert.ToInt32(match.Groups["width"].Value);
+                        int height = Convert.ToInt32(match.Groups["height"].Value);
+
+                        return new Rectangle(x, y, width, height);
+                    }
+
+                default:
+                    throw new SParseException($"Can't parse {typeof(Rectangle).Name} from {reader.Path}, must be an object or string.");
+            }
+        }
+
+        /// <summary>Writes the JSON representation of the object.</summary>
+        /// <param name="writer">The JSON writer.</param>
+        /// <param name="value">The value.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+        {
+            throw new InvalidOperationException("This converter does not write JSON.");
+        }
+    }
+}