Get rid of System.Drawing.Color

Author: kristiker

Arrays.cs

@@ -5,7 +5,6 @@
 using System.Diagnostics;
 using System.Linq;
 using System.Numerics;
-using System.Drawing;
 using System.Threading;
 using System.ComponentModel;
 
@@ -338,7 +337,7 @@ void ICollection.CopyTo(Array array, int index)
     }
 
     public class ElementArray : Array<Element>
-    {    
+    {
         public ElementArray() { }
 
         public ElementArray(IEnumerable<Element> enumerable)
@@ -587,10 +586,10 @@ public ByteArray(int capacity)
     }
 
     [CLSCompliant(false)]
-    public class UInt64Array : Array<UInt64>
+    public class UInt64Array : Array<ulong>
     {
         public UInt64Array() { }
-        public UInt64Array(IEnumerable<UInt64> enumerable)
+        public UInt64Array(IEnumerable<ulong> enumerable)
             : base(enumerable)
         { }
         public UInt64Array(int capacity)

AttributeList.cs

@@ -132,7 +132,7 @@ public void DeferredLoad()
             }
             catch (Exception err)
             {
-                throw new CodecException(String.Format("Deferred loading of attribute \"{0}\" on element {1} using codec {2} threw an exception.", Name, ((Element)Owner).ID, OwnerDatamodel.Codec), err);
+                throw new CodecException($"Deferred loading of attribute \"{Name}\" on element {((Element)Owner).ID} using {OwnerDatamodel.Codec} codec threw an exception.", err);
             }
             Offset = 0;
 

Codecs/Binary.cs

@@ -27,11 +27,21 @@ class Binary : IDeferredAttributeCodec, IDisposable
         static Binary()
         {
             SupportedAttributes[1] =
-            SupportedAttributes[2] = new Type[] { typeof(Element), typeof(int), typeof(float), typeof(bool), typeof(string), typeof(byte[]), null /* ObjectID */, typeof(System.Drawing.Color), typeof(Vector2), typeof(Vector3), typeof(Vector4), typeof(Vector3) /* angle*/, typeof(Quaternion), typeof(Matrix4x4) };
+            SupportedAttributes[2] = new Type[] {
+                typeof(Element), typeof(int), typeof(float), typeof(bool), typeof(string), typeof(byte[]),
+                null /* ObjectID */, typeof(Color), typeof(Vector2), typeof(Vector3), typeof(Vector4), typeof(Vector3) /* angle*/, typeof(Quaternion), typeof(Matrix4x4)
+            };
             SupportedAttributes[3] =
             SupportedAttributes[4] =
-            SupportedAttributes[5] = new Type[] { typeof(Element), typeof(int), typeof(float), typeof(bool), typeof(string), typeof(byte[]), typeof(TimeSpan), typeof(System.Drawing.Color), typeof(Vector2), typeof(Vector3), typeof(Vector4), typeof(Vector3) /* angle*/, typeof(Quaternion), typeof(Matrix4x4) };
-            SupportedAttributes[9] = new Type[] { typeof(Element), typeof(int), typeof(float), typeof(bool), typeof(string), typeof(byte[]), typeof(TimeSpan), typeof(System.Drawing.Color), typeof(Vector2), typeof(Vector3), typeof(Vector4), typeof(Vector3) /* angle*/, typeof(Quaternion), typeof(Matrix4x4), typeof(UInt64), typeof(byte) };
+            SupportedAttributes[5] = new Type[] {
+                typeof(Element), typeof(int), typeof(float), typeof(bool), typeof(string), typeof(byte[]),
+                typeof(TimeSpan), typeof(Color), typeof(Vector2), typeof(Vector3), typeof(Vector4), typeof(Vector3) /* angle*/, typeof(Quaternion), typeof(Matrix4x4)
+            };
+            SupportedAttributes[9] = new Type[] {
+                typeof(Element), typeof(int), typeof(float), typeof(bool), typeof(string), typeof(byte[]),
+                typeof(TimeSpan), typeof(Color), typeof(Vector2), typeof(Vector3), typeof(Vector4), typeof(Vector3) /* angle*/, typeof(Quaternion), typeof(Matrix4x4),
+                typeof(ulong), typeof(byte)/*, typeof(QAngle) */
+            };
         }
 
         public void Dispose()
@@ -262,10 +272,10 @@ object ReadValue(Datamodel dm, Type type, bool raw_string)
             if (type == typeof(TimeSpan))
                 return TimeSpan.FromTicks(Reader.ReadInt32() * (TimeSpan.TicksPerSecond / DatamodelTicksPerSecond));
 
-            if (type == typeof(System.Drawing.Color))
+            if (type == typeof(Color))
             {
                 var rgba = Reader.ReadBytes(4);
-                return System.Drawing.Color.FromArgb(rgba[3], rgba[0], rgba[1], rgba[2]);
+                return Color.FromBytes(rgba);
             }
 
             if (type == typeof(Vector2))
@@ -423,7 +433,7 @@ void SkipAttribute()
 
             if (type == typeof(TimeSpan))
                 length = sizeof(int);
-            else if (type == typeof(System.Drawing.Color))
+            else if (type == typeof(Color))
                 length = 4;
             else if (type == typeof(bool))
                 length = 1;
@@ -626,9 +636,9 @@ void WriteAttribute(object value, bool in_array)
                     return;
                 }
 
-                if (value is System.Drawing.Color colour_value)
+                if (value is Color colour_value)
                 {
-                    Writer.Write(new byte[] { colour_value.R, colour_value.G, colour_value.B, colour_value.A });
+                    Writer.Write(colour_value.ToBytes());
                     return;
                 }
 

Codecs/KeyValues2.cs

@@ -28,7 +28,7 @@ static KeyValues2()
             TypeNames[typeof(string)] = "string";
             TypeNames[typeof(byte[])] = "binary";
             TypeNames[typeof(TimeSpan)] = "time";
-            TypeNames[typeof(System.Drawing.Color)] = "color";
+            TypeNames[typeof(Color)] = "color";
             TypeNames[typeof(Vector2)] = "vector2";
             TypeNames[typeof(Vector3)] = "vector3";
             TypeNames[typeof(Vector4)] = "vector4";
@@ -240,9 +240,9 @@ void WriteAttribute(string name, Type type, object value, bool in_array)
                     value = BitConverter.ToString((byte[])value).Replace("-", String.Empty);
                 else if (type == typeof(TimeSpan))
                     value = ((TimeSpan)value).TotalSeconds;
-                else if (type == typeof(System.Drawing.Color))
+                else if (type == typeof(Color))
                 {
-                    var c = (System.Drawing.Color)value;
+                    var c = (Color)value;
                     value = String.Join(" ", new int[] { c.R, c.G, c.B, c.A });
                 }
                 else if (value is ulong ulong_value)
@@ -516,7 +516,7 @@ object Decode_ParseValue(Type type, string value)
             if (type == typeof(Element))
                 return Decode_ParseElement(value);
             if (type == typeof(int))
-                return Int32.Parse(value);
+                return int.Parse(value);
             else if (type == typeof(float))
                 return float.Parse(value);
             else if (type == typeof(bool))
@@ -535,13 +535,13 @@ object Decode_ParseValue(Type type, string value)
 
             var num_list = value.Split((char[])null, StringSplitOptions.RemoveEmptyEntries);
 
-            if (type == typeof(System.Drawing.Color))
+            if (type == typeof(Color))
             {
                 var rgba = num_list.Select(i => byte.Parse(i)).ToArray();
-                return System.Drawing.Color.FromArgb(rgba[3], rgba[0], rgba[1], rgba[2]);
+                return Color.FromBytes(rgba);
             }
 
-            if (type == typeof(UInt64)) return UInt64.Parse(value.Remove(0, 2), System.Globalization.NumberStyles.HexNumber);
+            if (type == typeof(ulong)) return ulong.Parse(value.Remove(0, 2), System.Globalization.NumberStyles.HexNumber);
             if (type == typeof(byte)) return byte.Parse(value);
 
             var f_list = num_list.Select(i => float.Parse(i)).ToArray();
@@ -554,8 +554,9 @@ object Decode_ParseValue(Type type, string value)
                 f_list[4], f_list[5], f_list[6], f_list[7],
                 f_list[8], f_list[9], f_list[10], f_list[11],
                 f_list[12], f_list[13], f_list[14], f_list[15]);
+            else if (type == typeof(QAngle)) return new QAngle(f_list[0], f_list[1], f_list[2]);
 
-            else throw new ArgumentException("Internal error: ParseValue passed unsupported Type.");
+            else throw new ArgumentException($"Internal error: ParseValue passed unsupported type: {type}.");
         }
 
         public Datamodel Decode(int encoding_version, string format, int format_version, Stream stream, DeferredMode defer_mode)
@@ -578,7 +579,7 @@ public Datamodel Decode(int encoding_version, string format, int format_version,
                 try
                 { Decode_ParseElement(next); }
                 catch (Exception err)
-                { throw new CodecException(String.Format("KeyValues2 decode failed on line {0}:\n\n{1}", Line, err.Message), err); }
+                { throw new CodecException($"KeyValues2 decode failed on line {Line}:\n\n{err.Message}", err); }
             }
 
             return DM;

Datamodel.cs

@@ -45,7 +45,7 @@ public DebugView(Datamodel dm)
             typeof(string),
             typeof(byte[]),
             typeof(TimeSpan),
-            typeof(System.Drawing.Color),
+            typeof(Color),
             typeof(Vector2),
             typeof(Vector3),
             typeof(Vector4),

ICodec.cs

@@ -100,7 +100,7 @@ public static System.Collections.IList MakeList(Type t, int count)
                 return new BinaryArray(count);
             if (t == typeof(TimeSpan))
                 return new TimeSpanArray(count);
-            if (t == typeof(System.Drawing.Color))
+            if (t == typeof(Color))
                 return new ColorArray(count);
             if (t == typeof(Vector2))
                 return new Vector2Array(count);
@@ -114,10 +114,10 @@ public static System.Collections.IList MakeList(Type t, int count)
                 return new MatrixArray(count);
             if (t == typeof(byte))
                 return new ByteArray(count);
-            if (t == typeof(UInt64))
+            if (t == typeof(ulong))
                 return new UInt64Array(count);
 
-            throw new ArgumentException("Unrecognised Type.");
+            throw new ArgumentException($"Unhandled or invalid type: {t}");
         }
 
         /// <summary>
@@ -139,8 +139,8 @@ public static System.Collections.IList MakeList(Type t, System.Collections.IEnum
                 return new BinaryArray(source.Cast<byte[]>());
             if (t == typeof(TimeSpan))
                 return new TimeSpanArray(source.Cast<TimeSpan>());
-            if (t == typeof(System.Drawing.Color))
-                return new ColorArray(source.Cast<System.Drawing.Color>());
+            if (t == typeof(Color))
+                return new ColorArray(source.Cast<Color>());
             if (t == typeof(Vector2))
                 return new Vector2Array(source.Cast<Vector2>());
             if (t == typeof(Vector3))
@@ -153,7 +153,7 @@ public static System.Collections.IList MakeList(Type t, System.Collections.IEnum
                 return new MatrixArray(source.Cast<Matrix4x4>());
             if (t == typeof(byte))
                 return new ByteArray(source.Cast<byte>());
-            if (t == typeof(UInt64))
+            if (t == typeof(ulong))
                 return new UInt64Array(source.Cast<UInt64>());
 
             throw new ArgumentException("Unrecognised Type.");

README.md

@@ -14,13 +14,12 @@ The following CLR types are supported as Datamodel attributes:
 * `byte[]`
 * `ulong`
 * `System.TimeSpan`
-* `System.Drawing.Color`
 
 Additionally, the following Datamodel.NET types are supported:
 
 * `Element` (a named collection of attributes)
 * `Vector2`
-* `Vector3` / `Angle`
+* `Vector3` / `QAngle`
 * `Vector4` / `Quaternion`
 * `Matrix` (4x4)
 
@@ -32,22 +31,10 @@ Additionally, the following Datamodel.NET types are supported:
 * Support for all known versions of Valve's `binary` and `keyvalues2` DMX encodings
 * Convenient `IEnumerable`, `INotifyPropertyChanged` and `INotifyCollectionChanged` implementations
 * Supports partial trust
-* Supports XAML
 * Inline documentation
 * Binary codec supports just-in-time attribute loading
 * Write your own codecs with the `ICodec` interface
-
-### Data Binding
-
-You can bind to an attribute as if it were a property of the host element, e.g. `{Binding MyElement.Hello}`. If an attribute's name collides with a statically-defined property of `Element` then use indexer syntax instead, e.g. `{Binding MyElement[Owner]}`.
-
-### ObservableAttribute
-
-In order to correctly implement `IDictionary`, attributes are exposed as `KeyValuePair` objects. Since these aren't great for data binding the utility type `ObservableAttribute` is provided.
-
-`ObservableAttribute` will automatically wrap its descendants. For further binding convenience it will also wrap array items, generating an index-based label in place of an attribute key for each.
-
-An `IValueConverter` class is provided in a comment block at the start of `ObservableAttribute`'s class definition.
+* Support for property based attributes
 
 ## Quick example
 
@@ -62,12 +49,9 @@ var MyString = HelloWorld.Root.Get<string>("Hello");
 HelloWorld.Save("hello world.dmx", "keyvalues2", 1); // must provide an encoding name and version
 ```
 
-```xml
-<Datamodel Format="helloworld" FormatVersion="1">
-    <Datamodel.Root>
-        <Element Name="my_root">
-            <sys:String x:Key="Hello">World</sys:String>
-        </Element>
-    </Datamodel.Root>
-</Datamodel>
+```vdf
+<--! dmx encoding keyvalues2 1 format helloworld 1>
+{
+    "Hello" "string" "World"
+}
 ```

Tests/Tests.cs

@@ -8,7 +8,6 @@
 using Datamodel;
 using System.Numerics;
 using DM = Datamodel.Datamodel;
-using System.Text;
 
 namespace Datamodel_Tests
 {
@@ -29,13 +28,29 @@ static DatamodelTests()
             Random.Shared.NextBytes(binary);
             var quat = Quaternion.Normalize(new Quaternion(1, 2, 3, 4)); // dmxconvert will normalise this if I don't!
 
-            TestValues_V1 = new List<object>(new object[] { "hello_world", 1, 1.5f, true, binary, null, System.Drawing.Color.Blue,
-                new Vector2(1,2), new Vector3(1,2,3), new Vector4(1,2,3,4), quat, new Matrix4x4(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16) });
+            TestValues_V1 = new List<object> {
+                "hello_world",
+                1,
+                1.5f,
+                true,
+                binary,
+                null,
+                new Color(1, 255, 2, 244),
+                new Vector2(1,2),
+                new Vector3(1,2,3),
+                new Vector4(1,2,3,4),
+                quat,
+                new Matrix4x4(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16)
+            };
 
             TestValues_V2 = TestValues_V1.ToList();
-            TestValues_V2[5] = TimeSpan.FromMinutes(5) + TimeSpan.FromTicks(TimeSpan.TicksPerMillisecond / 2);
+            TestValues_V2.Add(TimeSpan.FromMinutes(5) + TimeSpan.FromTicks(TimeSpan.TicksPerMillisecond / 2));
 
-            TestValues_V3 = TestValues_V1.Concat(new object[] { (byte)0xFF, (UInt64)0xFFFFFFFF }).ToList();
+            TestValues_V3 = TestValues_V1.Concat(new object[] {
+                (byte)0xFF,
+                (ulong)0xFFFFFFFF,
+                //new QAngle(0, 90, 180)
+            }).ToList();
         }
 
 
@@ -173,7 +188,7 @@ private void CompareVector(DM dm, string name, float[] actual)
                 Assert.AreEqual(t.Item1, t.Item2, 1e-6, name);
         }
 
-        protected void ValidatePopulated(string encoding_name, int encoding_version)
+        protected static void ValidatePopulated(string encoding_name, int encoding_version)
         {
             var dm = DM.Load(DmxConvertPath);
             Assert.AreEqual(RootGuid, dm.Root.ID);
@@ -182,13 +197,12 @@ protected void ValidatePopulated(string encoding_name, int encoding_version)
                 if (value == null) continue;
                 var name = value.GetType().Name;
 
-                if (value is ICollection)
-                    CollectionAssert.AreEqual((ICollection)value, (ICollection)dm.Root[name]);
-                else if (value is System.Drawing.Color)
-                    Assert.AreEqual(((System.Drawing.Color)value).ToArgb(), dm.Root.Get<System.Drawing.Color>(name).ToArgb());
-                else if (value is Quaternion)
+                if (value is ICollection collection)
+                    CollectionAssert.AreEqual(collection, (ICollection)dm.Root[name]);
+                else if (value is Color color)
+                    Assert.AreEqual(color, dm.Root.Get<Color>(name));
+                else if (value is Quaternion quat)
                 {
-                    var quat = (Quaternion)value;
                     var expected = dm.Root.Get<Quaternion>(name);
                     Assert.AreEqual(quat.W, expected.W, 1e-6, name + " W");
                     Assert.AreEqual(quat.X, expected.X, 1e-6, name + " X");
@@ -202,7 +216,7 @@ protected void ValidatePopulated(string encoding_name, int encoding_version)
             dm.Dispose();
         }
 
-        protected DM Create(string encoding, int version, bool memory_save = false)
+        protected static DM Create(string encoding, int version, bool memory_save = false)
         {
             var dm = MakeDatamodel();
             Populate(dm, encoding, version);

Types/Color.cs

@@ -0,0 +1,44 @@
+using System;
+
+namespace Datamodel;
+
+public struct Color : IEquatable<Color>
+{
+    public byte R;
+    public byte G;
+    public byte B;
+    public byte A;
+
+    public Color(byte r, byte g, byte b, byte a)
+    {
+        R = r;
+        G = g;
+        B = b;
+        A = a;
+    }
+
+    public static bool operator ==(Color first, Color second)
+        => first.R == second.R && first.G == second.G && first.B == second.B && first.A == second.A;
+
+    public static bool operator !=(Color a, Color b)
+        => !(a == b);
+
+    public static Color FromBytes(byte[] bytes)
+        => new(bytes[0], bytes[1], bytes[2], bytes[3]);
+
+    public byte[] ToBytes()
+        => new byte[] { R, G, B, A };
+
+    public override int GetHashCode()
+        => HashCode.Combine(R, G, B, A);
+
+    public bool Equals(Color other)
+        => this == other;
+
+    public override bool Equals(object obj)
+    {
+        if (obj is Color color)
+            return this == color;
+        return false;
+    }
+}