[src] Add CGSize/CGPoint/CGRectDictionary

Author: rolfbjarne

src/CoreGraphics/CGPoint.cs

@@ -154,11 +154,10 @@ public CGPoint (CGPoint point)
 			this.y = point.y;
 		}
 
-		/// <param name="dictionaryRepresentation">To be added.</param>
-		///         <param name="point">To be added.</param>
-		///         <summary>To be added.</summary>
-		///         <returns>To be added.</returns>
-		///         <remarks>To be added.</remarks>
+		/// <summary>Attempts to parse the contents of an <see cref="NSDictionary" /> with a serialized <see cref="CGPoint" /> into a <see cref="CGPoint" />.</summary>
+		/// <param name="dictionaryRepresentation">The dictionary to parse.</param>
+		/// <param name="point">If successful, the resulting <see cref="CGPoint" /> value.</param>
+		/// <returns><see langword="true" /> if the dictionary was serialized successfully, <see langword="false" /> otherwise.</returns>
 		public static bool TryParse (NSDictionary? dictionaryRepresentation, out CGPoint point)
 		{
 			if (dictionaryRepresentation is null) {
@@ -173,13 +172,32 @@ public static bool TryParse (NSDictionary? dictionaryRepresentation, out CGPoint
 			}
 		}
 
-		/// <summary>To be added.</summary>
-		///         <returns>To be added.</returns>
-		///         <remarks>To be added.</remarks>
+		/// <summary>Serializes a <see cref="CGPoint" /> into an <see cref="Foundation.NSDictionary" />.</summary>
+		/// <returns>A <see cref="Foundation.NSDictionary" /> with the values from this <see cref="CGPoint" />.</returns>
+		/// <remarks>
+		///   <para>
+		///     The returned dictionary conforms to the serialization
+		///     standard of Cocoa and CocoaTouch and can be used to serialize
+		///     the state into objects that can be parsed by other Apple APIs.
+		///   </para>
+		///   <para>
+		///     It is possible to create a <see cref="CGPoint" /> from an <see cref="NSDictionary" /> using
+		///     the <see cref="TryParse(NSDictionary,out CGPoint)" /> method.
+		///   </para>
+		/// </remarks>
+		/// <seealso cref="ToCGPointDictionary" />
 		public NSDictionary ToDictionary ()
 		{
 			return new NSDictionary (NativeDrawingMethods.CGPointCreateDictionaryRepresentation (this));
 		}
+
+		/// <summary>Serializes a <see cref="CGPoint" /> into a <see cref="CGPointDictionary" />.</summary>
+		/// <returns>A <see cref="CGPointDictionary" /> representing the values from this <see cref="CGPoint" />.</returns>
+		/// <seealso cref="ToDictionary" />
+		public CGPointDictionary ToCGPointDictionary ()
+		{
+			return new CGPointDictionary (ToDictionary ());
+		}
 #endif // !COREBUILD
 
 		/// <param name="obj">To be added.</param>

src/CoreGraphics/CGPointDictionary.cs

@@ -0,0 +1,41 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Foundation;
+
+namespace CoreGraphics;
+
+/// <summary>This class represents a <see cref="CGPoint" /> stored in a dictionary; that is a dictionary with "X" and "Y" keys for the corresponding <see cref="CGPoint" /> fields.</summary>
+public class CGPointDictionary : DictionaryContainer {
+#if !COREBUILD
+	/// <summary>Creates a new <see cref="CGPointDictionary" /> with default (empty) values.</summary>
+	[Preserve (Conditional = true)]
+	public CGPointDictionary () : base (new NSMutableDictionary ()) {}
+
+	/// <summary>Creates a new <see cref="CGPointDictionary" /> from the values that are specified in <paramref name="dictionary" />.</summary>
+	/// <param name="dictionary">The dictionary to use to populate the properties of this type.</param>
+	[Preserve (Conditional = true)]
+	public CGPointDictionary (NSDictionary? dictionary) : base (dictionary) {}
+
+	/// <summary>The X component of the <see cref="CGPoint" />.</summary>
+	public nfloat? X {
+		get => GetNFloatValue ((NSString) "X");
+		set => SetNumberValue ((NSString) "X", value);
+	}
+
+	/// <summary>The Y component of the <see cref="CGPoint" />.</summary>
+	public nfloat? Y {
+		get => GetNFloatValue ((NSString) "Y");
+		set => SetNumberValue ((NSString) "Y", value);
+	}
+
+	/// <summary>Get the <see cref="CGPoint" /> stored in this dictionary.</summary>
+	/// <returns>The <see cref="CGPoint" /> stored in this dictionary.</returns>
+	public CGPoint ToPoint ()
+	{
+		if (CGPoint.TryParse (Dictionary, out var rv))
+			return rv;
+		return default;
+	}
+#endif // !COREBUILD
+}

src/CoreGraphics/CGRect.cs

@@ -547,17 +547,10 @@ public void Deconstruct (out CGPoint location, out CGSize size)
 			size = Size;
 		}
 
-		/// <param name="dictionaryRepresentation">Dictionary containing
-		/// 	a serialized CGRect.</param>
-		///         <param name="rect">The rectangle value with the contents if
-		/// 	the return value is true.</param>
-		///         <summary>To be added.</summary>
-		///         <returns>True if the NSDictionary contained a serialized
-		/// 	CGRect and the initialized <paramref name="rect" />  with the
-		/// 	contents on return.   False on failure, and the contents of
-		/// 	<paramref name="rect" /> are set to Empty in that case.</returns>
-		///         <remarks>Used to create a CGRect from a dictionary containing
-		/// 	keys for X, Y, Widht and Height.</remarks>
+		/// <summary>Attempts to parse the contents of an <see cref="NSDictionary" /> with a serialized <see cref="CGRect" /> into a <see cref="CGRect" />.</summary>
+		/// <param name="dictionaryRepresentation">The dictionary to parse.</param>
+		/// <param name="rect">If successful, the resulting <see cref="CGRect" /> value.</param>
+		/// <returns><see langword="true" /> if the dictionary was serialized successfully, <see langword="false" /> otherwise.</returns>
 		public static bool TryParse (NSDictionary? dictionaryRepresentation, out CGRect rect)
 		{
 			if (dictionaryRepresentation is null) {
@@ -572,25 +565,33 @@ public static bool TryParse (NSDictionary? dictionaryRepresentation, out CGRect
 			}
 		}
 
-		/// <summary>Serializes the state of the rectangle into an NSDictionary.</summary>
-		///         <returns>An NSDictionary representing the rectangle.</returns>
-		///         <remarks>
-		///           <para>
-		/// 	    The returned dictionary conforms to the serialization
-		/// 	    standard of Cocoa and CocoaTouch and can be used to serialize
-		/// 	    the state into objects that can be parsed by other Apple APIs.
-		/// 	  </para>
-		///           <para>
-		/// 	    It is possible to create CGRect from a Dictionary using
-		/// 	    the <see cref="CoreGraphics.CGRect.TryParse(Foundation.NSDictionary,out CoreGraphics.CGRect)" />
-		/// 	    method. 
-		/// 	  </para>
-		///         </remarks>
+		/// <summary>Serializes a <see cref="CGRect" /> into an <see cref="NSDictionary" />.</summary>
+		/// <returns>An <see cref="NSDictionary" /> with the values from this <see cref="CGRect" />.</returns>
+		/// <remarks>
+		///   <para>
+		///     The returned dictionary conforms to the serialization
+		///     standard of Cocoa and CocoaTouch and can be used to serialize
+		///     the state into objects that can be parsed by other Apple APIs.
+		///   </para>
+		///   <para>
+		///     It is possible to create a <see cref="CGRect" /> from an <see cref="NSDictionary" /> using
+		///     the <see cref="TryParse(NSDictionary,out CGRect)" /> method.
+		///   </para>
+		/// </remarks>
+		/// <seealso cref="ToCGRectDictionary" />
 		public NSDictionary ToDictionary ()
 		{
 			return new NSDictionary (NativeDrawingMethods.CGRectCreateDictionaryRepresentation (this));
 		}
 
+		/// <summary>Serializes a <see cref="CGRect" /> into a <see cref="CGRectDictionary" />.</summary>
+		/// <returns>A <see cref="CGRectDictionary" /> representing the values from this <see cref="CGRect" />.</returns>
+		/// <seealso cref="ToDictionary" />
+		public CGRectDictionary ToCGRectDictionary ()
+		{
+			return new CGRectDictionary (ToDictionary ());
+		}
+
 #if MONOMAC
 		// <quote>When building for 64 bit systems, or building 32 bit like 64 bit, NSRect is typedef’d to CGRect.</quote>
 		// https://developer.apple.com/documentation/foundation/nsrect?language=objc

src/CoreGraphics/CGRectDictionary.cs

@@ -0,0 +1,53 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Foundation;
+
+namespace CoreGraphics;
+
+/// <summary>This class represents a <see cref="CGRect" /> stored in a dictionary; that is a dictionary with "X", "Y", Width" and "Height" keys for the corresponding <see cref="CGRect" /> fields.</summary>
+public class CGRectDictionary : DictionaryContainer {
+#if !COREBUILD
+	/// <summary>Creates a new <see cref="CGRectDictionary" /> with default (empty) values.</summary>
+	[Preserve (Conditional = true)]
+	public CGRectDictionary () : base (new NSMutableDictionary ()) {}
+
+	/// <summary>Creates a new <see cref="CGRectDictionary" /> from the values that are specified in <paramref name="dictionary" />.</summary>
+	/// <param name="dictionary">The dictionary to use to populate the properties of this type.</param>
+	[Preserve (Conditional = true)]
+	public CGRectDictionary (NSDictionary? dictionary) : base (dictionary) {}
+
+	/// <summary>The X component of the <see cref="CGPoint" />.</summary>
+	public nfloat? X {
+		get => GetNFloatValue ((NSString) "X");
+		set => SetNumberValue ((NSString) "X", value);
+	}
+
+	/// <summary>The Y component of the <see cref="CGPoint" />.</summary>
+	public nfloat? Y {
+		get => GetNFloatValue ((NSString) "Y");
+		set => SetNumberValue ((NSString) "Y", value);
+	}
+
+	/// <summary>The width component of the <see cref="CGSize" />.</summary>
+	public nfloat? Width {
+		get => GetNFloatValue ((NSString) "Width");
+		set => SetNumberValue ((NSString) "Width", value);
+	}
+
+	/// <summary>The height component of the <see cref="CGSize" />.</summary>
+	public nfloat? Height {
+		get => GetNFloatValue ((NSString) "Height");
+		set => SetNumberValue ((NSString) "Height", value);
+	}
+
+	/// <summary>Get the <see cref="CGRect" /> stored in this dictionary.</summary>
+	/// <returns>The <see cref="CGRect" /> stored in this dictionary.</returns>
+	public CGRect ToRect ()
+	{
+		if (CGRect.TryParse (Dictionary, out var rv))
+			return rv;
+		return default;
+	}
+#endif // !COREBUILD
+}

src/CoreGraphics/CGSize.cs

@@ -156,11 +156,10 @@ public CGSize (CGSize size)
 			this.height = size.height;
 		}
 
-		/// <param name="dictionaryRepresentation">To be added.</param>
-		///         <param name="size">To be added.</param>
-		///         <summary>Attempts to parse the contents of an NSDictionary with a serialized CGSize into a CGSize.</summary>
-		///         <returns>To be added.</returns>
-		///         <remarks>To be added.</remarks>
+		/// <summary>Attempts to parse the contents of an <see cref="NSDictionary" /> with a serialized <see cref="CGSize" /> into a <see cref="CGSize" />.</summary>
+		/// <param name="dictionaryRepresentation">The dictionary to parse.</param>
+		/// <param name="size">If successful, the resulting <see cref="CGSize" /> value.</param>
+		/// <returns><see langword="true" /> if the dictionary was serialized successfully, <see langword="false" /> otherwise.</returns>
 		public static bool TryParse (NSDictionary? dictionaryRepresentation, out CGSize size)
 		{
 			if (dictionaryRepresentation is null) {
@@ -175,14 +174,33 @@ public static bool TryParse (NSDictionary? dictionaryRepresentation, out CGSize
 			}
 		}
 
-		/// <summary>Serializes a CGSize into an <see cref="Foundation.NSDictionary" />.</summary>
-		///         <returns>To be added.</returns>
-		///         <remarks>To be added.</remarks>
+		/// <summary>Serializes a <see cref="CGSize" /> into an <see cref="Foundation.NSDictionary" />.</summary>
+		/// <returns>A <see cref="Foundation.NSDictionary" /> with the values from this <see cref="CGSize" />.</returns>
+		/// <remarks>
+		///   <para>
+		///     The returned dictionary conforms to the serialization
+		///     standard of Cocoa and CocoaTouch and can be used to serialize
+		///     the state into objects that can be parsed by other Apple APIs.
+		///   </para>
+		///   <para>
+		///     It is possible to create a <see cref="CGSize" /> from an <see cref="NSDictionary" /> using
+		///     the <see cref="TryParse(NSDictionary,out CGSize)" /> method.
+		///   </para>
+		/// </remarks>
+		/// <seealso cref="ToCGSizeDictionary" />
 		public NSDictionary ToDictionary ()
 		{
 			return new NSDictionary (NativeDrawingMethods.CGSizeCreateDictionaryRepresentation (this));
 		}
 
+		/// <summary>Serializes a <see cref="CGSize" /> into a <see cref="CGSizeDictionary" />.</summary>
+		/// <returns>A <see cref="CGSizeDictionary" /> representing the values from this <see cref="CGSize" />.</returns>
+		/// <seealso cref="ToDictionary" />
+		public CGSizeDictionary ToCGSizeDictionary ()
+		{
+			return new CGSizeDictionary (ToDictionary ());
+		}
+
 		/// <param name="point">To be added.</param>
 		///         <summary>Initializes a CGSize object from a CGPoint.</summary>
 		///         <remarks>To be added.</remarks>

src/CoreGraphics/CGSizeDictionary.cs

@@ -0,0 +1,41 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Foundation;
+
+namespace CoreGraphics;
+
+/// <summary>This class represents a <see cref="CGSize" /> stored in a dictionary; that is a dictionary with "Width" and "Height" keys for the corresponding <see cref="CGSize" /> fields.</summary>
+public class CGSizeDictionary : DictionaryContainer {
+#if !COREBUILD
+	/// <summary>Creates a new <see cref="CGSizeDictionary" /> with default (empty) values.</summary>
+	[Preserve (Conditional = true)]
+	public CGSizeDictionary () : base (new NSMutableDictionary ()) {}
+
+	/// <summary>Creates a new <see cref="CGSizeDictionary" /> from the values that are specified in <paramref name="dictionary" />.</summary>
+	/// <param name="dictionary">The dictionary to use to populate the properties of this type.</param>
+	[Preserve (Conditional = true)]
+	public CGSizeDictionary (NSDictionary? dictionary) : base (dictionary) {}
+
+	/// <summary>The width component of the <see cref="CGSize" />.</summary>
+	public nfloat? Width {
+		get => GetNFloatValue ((NSString) "Width");
+		set => SetNumberValue ((NSString) "Width", value);
+	}
+
+	/// <summary>The height component of the <see cref="CGSize" />.</summary>
+	public nfloat? Height {
+		get => GetNFloatValue ((NSString) "Height");
+		set => SetNumberValue ((NSString) "Height", value);
+	}
+
+	/// <summary>Get the <see cref="CGSize" /> stored in this dictionary.</summary>
+	/// <returns>The <see cref="CGSize" /> stored in this dictionary.</returns>
+	public CGSize ToSize ()
+	{
+		if (CGSize.TryParse (Dictionary, out var rv))
+			return rv;
+		return default;
+	}
+#endif // !COREBUILD
+}

tests/monotouch-test/CoreGraphics/CGPointDictionaryTests.cs

@@ -0,0 +1,68 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+
+using Foundation;
+using CoreGraphics;
+using ObjCRuntime;
+
+using NUnit.Framework;
+
+namespace MonoTouchFixtures.CoreGraphics;
+
+[TestFixture]
+[Preserve (AllMembers = true)]
+public class CGPointDictionaryTests {
+
+	[Test]
+	public void PropertiesTest ()
+	{
+		Assert.Multiple (() => {
+			var point = new CGPoint ((nfloat) 1, (nfloat) 2);
+			using var dict = point.ToDictionary ();
+			var strongDict = new CGPointDictionary (dict);
+			Assert.AreEqual (point.X, strongDict.X, "X");
+			Assert.AreEqual (point.Y, strongDict.Y, "Y");
+
+			var point2 = strongDict.ToPoint ();
+			Assert.AreEqual (point, point2, "Point");
+
+			strongDict = new CGPointDictionary ();
+			strongDict.X = 3;
+			Assert.AreEqual ((nfloat) 3, strongDict.X, "X 2");
+			strongDict.Y = 4;
+			Assert.AreEqual ((nfloat) 4, strongDict.Y, "Y 2");
+			point2 = strongDict.ToPoint ();
+			Assert.AreEqual (new CGPoint (3, 4), point2, "Point 2");
+		});
+	}
+
+	[Test]
+	public void Default ()
+	{
+		var strongDict = new CGPointDictionary ();
+		Assert.IsNull (strongDict.X, "X");
+		Assert.IsNull (strongDict.Y, "Y");
+		var point = strongDict.ToPoint ();
+		Assert.AreEqual (default (CGPoint), point, "Point");
+	}
+
+	[Test]
+	public void ToStringTest1 ()
+	{
+		var strongDict = new CGPointDictionary ();
+		Assert.AreEqual ("CoreGraphics.CGPointDictionary", strongDict.ToString (), "A");
+		Assert.AreEqual ("{\n}", strongDict.Dictionary.ToString (), "B");
+	}
+
+	[Test]
+	public void ToStringTest2 ()
+	{
+		var strongDict = new CGPointDictionary ();
+		strongDict.X = 3;
+		strongDict.Y = 4;
+		Assert.AreEqual ("CoreGraphics.CGPointDictionary", strongDict.ToString (), "A");
+		Assert.AreEqual ("{\n    X = 3;\n    Y = 4;\n}", strongDict.Dictionary.ToString (), "B");
+	}
+}