Add interface for root child elements

Sergio0694 · Sergio0694 · commit e929ee953e78 · 2022-05-25T23:28:08.000+02:00
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Adaptive/Elements/Element_AdaptiveGroup.cs b/Microsoft.Toolkit.Uwp.Notifications/Adaptive/Elements/Element_AdaptiveGroup.cs
@@ -6,7 +6,7 @@
 
 namespace Microsoft.Toolkit.Uwp.Notifications.Adaptive.Elements
 {
-    internal sealed class Element_AdaptiveGroup : IElement_TileBindingChild, IElement_ToastBindingChild, IElementWithDescendants, IHaveXmlName
+    internal sealed class Element_AdaptiveGroup : IElement_TileBindingChild, IElement_ToastBindingChild, IElementWithDescendants, IHaveXmlName, IHaveXmlChildren
     {
         public IList<Element_AdaptiveSubgroup> Children { get; private set; } = new List<Element_AdaptiveSubgroup>();
 
@@ -27,5 +27,8 @@ public IEnumerable<object> Descendants()
 
         /// <inheritdoc/>
         string IHaveXmlName.Name => "group";
+
+        /// <inheritdoc/>
+        IEnumerable<object> IHaveXmlChildren.Children => Children;
     }
 }
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Adaptive/Elements/Element_AdaptiveSubgroup.cs b/Microsoft.Toolkit.Uwp.Notifications/Adaptive/Elements/Element_AdaptiveSubgroup.cs
@@ -7,7 +7,7 @@
 
 namespace Microsoft.Toolkit.Uwp.Notifications.Adaptive.Elements
 {
-    internal sealed class Element_AdaptiveSubgroup : IElementWithDescendants, IHaveXmlName, IHaveXmlNamedProperties
+    internal sealed class Element_AdaptiveSubgroup : IElementWithDescendants, IHaveXmlName, IHaveXmlNamedProperties, IHaveXmlChildren
     {
         internal const AdaptiveSubgroupTextStacking DEFAULT_TEXT_STACKING = AdaptiveSubgroupTextStacking.Default;
 
@@ -54,6 +54,9 @@ public IEnumerable<object> Descendants()
         /// <inheritdoc/>
         string IHaveXmlName.Name => "subgroup";
 
+        /// <inheritdoc/>
+        IEnumerable<object> IHaveXmlChildren.Children => Children;
+
         /// <inheritdoc/>
         IEnumerable<KeyValuePair<string, object>> IHaveXmlNamedProperties.EnumerateNamedProperties()
         {
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Common/Serialization/IHaveXmlChildren.cs b/Microsoft.Toolkit.Uwp.Notifications/Common/Serialization/IHaveXmlChildren.cs
@@ -0,0 +1,20 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Collections.Generic;
+
+#nullable enable
+
+namespace Microsoft.Toolkit.Uwp.Notifications;
+
+/// <summary>
+/// An interface for a notification XML element with additional children.
+/// </summary>
+internal interface IHaveXmlChildren
+{
+    /// <summary>
+    /// Gets the children of the current element.
+    /// </summary>
+    IEnumerable<object> Children { get; }
+}
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Common/XmlWriterHelper.cs b/Microsoft.Toolkit.Uwp.Notifications/Common/XmlWriterHelper.cs
@@ -57,14 +57,15 @@ public static void Write(System.Xml.XmlWriter writer, object element)
                 {
                     continue;
                 }
+                else if (p.Name == nameof(IHaveXmlChildren.Children) && element is IHaveXmlChildren && p.PropertyType == typeof(IEnumerable<object>))
+                {
+                    continue;
+                }
 
                 // Otherwise it's an element or collection of elements
                 else
                 {
-                    if (propertyValue != null)
-                    {
-                        elements.Add(propertyValue);
-                    }
+                    continue;
                 }
             }
 
@@ -83,20 +84,14 @@ public static void Write(System.Xml.XmlWriter writer, object element)
                 }
             }
 
+            foreach (var child in (element as IHaveXmlChildren)?.Children ?? Enumerable.Empty<object>())
+            {
+                elements.Add(child);
+            }
+
             // Then write children
             foreach (object el in elements)
             {
-                // If it's a collection of children
-                if (el is IEnumerable)
-                {
-                    foreach (object child in el as IEnumerable)
-                    {
-                        Write(writer, child);
-                    }
-
-                    continue;
-                }
-
                 // Otherwise just write the single element
                 Write(writer, el);
             }
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Tiles/Elements/Element_Tile.cs b/Microsoft.Toolkit.Uwp.Notifications/Tiles/Elements/Element_Tile.cs
@@ -2,13 +2,18 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System.Collections.Generic;
+
 namespace Microsoft.Toolkit.Uwp.Notifications
 {
-    internal sealed class Element_Tile : BaseElement, IHaveXmlName
+    internal sealed class Element_Tile : BaseElement, IHaveXmlName, IHaveXmlChildren
     {
         public Element_TileVisual Visual { get; set; }
 
         /// <inheritdoc/>
         string IHaveXmlName.Name => "tile";
+
+        /// <inheritdoc/>
+        IEnumerable<object> IHaveXmlChildren.Children => new[] { Visual };
     }
 }
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Tiles/Elements/Element_TileBinding.cs b/Microsoft.Toolkit.Uwp.Notifications/Tiles/Elements/Element_TileBinding.cs
@@ -7,7 +7,7 @@
 
 namespace Microsoft.Toolkit.Uwp.Notifications
 {
-    internal sealed class Element_TileBinding : IElementWithDescendants, IHaveXmlName, IHaveXmlNamedProperties
+    internal sealed class Element_TileBinding : IElementWithDescendants, IHaveXmlName, IHaveXmlNamedProperties, IHaveXmlChildren
     {
         internal const TileBranding DEFAULT_BRANDING = TileBranding.Auto;
         internal const TileTextStacking DEFAULT_TEXT_STACKING = TileTextStacking.Top;
@@ -122,6 +122,9 @@ public IEnumerable<object> Descendants()
         /// <inheritdoc/>
         string IHaveXmlName.Name => "binding";
 
+        /// <inheritdoc/>
+        IEnumerable<object> IHaveXmlChildren.Children => Children;
+
         /// <inheritdoc/>
         IEnumerable<KeyValuePair<string, object>> IHaveXmlNamedProperties.EnumerateNamedProperties()
         {
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Tiles/Elements/Element_TileVisual.cs b/Microsoft.Toolkit.Uwp.Notifications/Tiles/Elements/Element_TileVisual.cs
@@ -7,7 +7,7 @@
 
 namespace Microsoft.Toolkit.Uwp.Notifications
 {
-    internal sealed class Element_TileVisual : IHaveXmlName, IHaveXmlNamedProperties
+    internal sealed class Element_TileVisual : IHaveXmlName, IHaveXmlNamedProperties, IHaveXmlChildren
     {
         internal const TileBranding DEFAULT_BRANDING = TileBranding.Auto;
         internal const bool DEFAULT_ADD_IMAGE_QUERY = false;
@@ -38,6 +38,9 @@ internal sealed class Element_TileVisual : IHaveXmlName, IHaveXmlNamedProperties
         /// <inheritdoc/>
         string IHaveXmlName.Name => "visual";
 
+        /// <inheritdoc/>
+        IEnumerable<object> IHaveXmlChildren.Children => Bindings;
+
         /// <inheritdoc/>
         IEnumerable<KeyValuePair<string, object>> IHaveXmlNamedProperties.EnumerateNamedProperties()
         {
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Toasts/Elements/Element_Toast.cs b/Microsoft.Toolkit.Uwp.Notifications/Toasts/Elements/Element_Toast.cs
@@ -7,7 +7,7 @@
 
 namespace Microsoft.Toolkit.Uwp.Notifications
 {
-    internal sealed class Element_Toast : BaseElement, IElement_ToastActivatable, IHaveXmlAdditionalProperties, IHaveXmlName, IHaveXmlNamedProperties
+    internal sealed class Element_Toast : BaseElement, IElement_ToastActivatable, IHaveXmlAdditionalProperties, IHaveXmlName, IHaveXmlNamedProperties, IHaveXmlChildren
     {
         internal const ToastScenario DEFAULT_SCENARIO = ToastScenario.Default;
         internal const Element_ToastActivationType DEFAULT_ACTIVATION_TYPE = Element_ToastActivationType.Foreground;
@@ -85,6 +85,9 @@ public static Element_ToastActivationType ConvertActivationType(ToastActivationT
         /// <inheritdoc/>
         string IHaveXmlName.Name => "toast";
 
+        /// <inheritdoc/>
+        IEnumerable<object> IHaveXmlChildren.Children => new object[] { Visual, Audio, Actions, Header };
+
         /// <inheritdoc/>
         IEnumerable<KeyValuePair<string, object>> IHaveXmlNamedProperties.EnumerateNamedProperties()
         {
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Toasts/Elements/Element_ToastActions.cs b/Microsoft.Toolkit.Uwp.Notifications/Toasts/Elements/Element_ToastActions.cs
@@ -6,7 +6,7 @@
 
 namespace Microsoft.Toolkit.Uwp.Notifications
 {
-    internal sealed class Element_ToastActions : IHaveXmlName, IHaveXmlNamedProperties
+    internal sealed class Element_ToastActions : IHaveXmlName, IHaveXmlNamedProperties, IHaveXmlChildren
     {
         internal const ToastSystemCommand DEFAULT_SYSTEM_COMMAND = ToastSystemCommand.None;
 
@@ -18,6 +18,9 @@ internal sealed class Element_ToastActions : IHaveXmlName, IHaveXmlNamedProperti
         /// <inheritdoc/>
         string IHaveXmlName.Name => "actions";
 
+        /// <inheritdoc/>
+        IEnumerable<object> IHaveXmlChildren.Children => Children;
+
         /// <inheritdoc/>
         IEnumerable<KeyValuePair<string, object>> IHaveXmlNamedProperties.EnumerateNamedProperties()
         {
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Toasts/Elements/Element_ToastBinding.cs b/Microsoft.Toolkit.Uwp.Notifications/Toasts/Elements/Element_ToastBinding.cs
@@ -7,7 +7,7 @@
 
 namespace Microsoft.Toolkit.Uwp.Notifications
 {
-    internal sealed class Element_ToastBinding : IHaveXmlName, IHaveXmlNamedProperties
+    internal sealed class Element_ToastBinding : IHaveXmlName, IHaveXmlNamedProperties, IHaveXmlChildren
     {
         public Element_ToastBinding(ToastTemplateType template)
         {
@@ -49,6 +49,9 @@ public Element_ToastBinding(ToastTemplateType template)
         /// <inheritdoc/>
         string IHaveXmlName.Name => "binding";
 
+        /// <inheritdoc/>
+        IEnumerable<object> IHaveXmlChildren.Children => Children;
+
         /// <inheritdoc/>
         IEnumerable<KeyValuePair<string, object>> IHaveXmlNamedProperties.EnumerateNamedProperties()
         {
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Toasts/Elements/Element_ToastInput.cs b/Microsoft.Toolkit.Uwp.Notifications/Toasts/Elements/Element_ToastInput.cs
@@ -6,7 +6,7 @@
 
 namespace Microsoft.Toolkit.Uwp.Notifications
 {
-    internal sealed class Element_ToastInput : IElement_ToastActionsChild, IHaveXmlName, IHaveXmlNamedProperties
+    internal sealed class Element_ToastInput : IElement_ToastActionsChild, IHaveXmlName, IHaveXmlNamedProperties, IHaveXmlChildren
     {
         /// <summary>
         /// Gets or sets the required attributes for developers to retrieve user inputs once the app is activated (in the foreground or background).
@@ -40,6 +40,9 @@ internal sealed class Element_ToastInput : IElement_ToastActionsChild, IHaveXmlN
         /// <inheritdoc/>
         string IHaveXmlName.Name => "input";
 
+        /// <inheritdoc/>
+        IEnumerable<object> IHaveXmlChildren.Children => Children;
+
         /// <inheritdoc/>
         IEnumerable<KeyValuePair<string, object>> IHaveXmlNamedProperties.EnumerateNamedProperties()
         {
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Toasts/Elements/Element_ToastVisual.cs b/Microsoft.Toolkit.Uwp.Notifications/Toasts/Elements/Element_ToastVisual.cs
@@ -7,7 +7,7 @@
 
 namespace Microsoft.Toolkit.Uwp.Notifications
 {
-    internal sealed class Element_ToastVisual : IHaveXmlName, IHaveXmlNamedProperties
+    internal sealed class Element_ToastVisual : IHaveXmlName, IHaveXmlNamedProperties, IHaveXmlChildren
     {
         internal const bool DEFAULT_ADD_IMAGE_QUERY = false;
 
@@ -28,6 +28,9 @@ internal sealed class Element_ToastVisual : IHaveXmlName, IHaveXmlNamedPropertie
         /// <inheritdoc/>
         string IHaveXmlName.Name => "visual";
 
+        /// <inheritdoc/>
+        IEnumerable<object> IHaveXmlChildren.Children => Bindings;
+
         /// <inheritdoc/>
         IEnumerable<KeyValuePair<string, object>> IHaveXmlNamedProperties.EnumerateNamedProperties()
         {

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`namespace Microsoft.Toolkit.Uwp.Notifications.Adaptive.Elements`
`8`	`8`	`{`
`9`		`- internal sealed class Element_AdaptiveGroup : IElement_TileBindingChild, IElement_ToastBindingChild, IElementWithDescendants, IHaveXmlName`
	`9`	`+ internal sealed class Element_AdaptiveGroup : IElement_TileBindingChild, IElement_ToastBindingChild, IElementWithDescendants, IHaveXmlName, IHaveXmlChildren`
`10`	`10`	`{`
`11`	`11`	`public IList<Element_AdaptiveSubgroup> Children { get; private set; } = new List<Element_AdaptiveSubgroup>();`
`12`	`12`
`@@ -27,5 +27,8 @@ public IEnumerable<object> Descendants()`
`27`	`27`
`28`	`28`	`/// <inheritdoc/>`
`29`	`29`	`string IHaveXmlName.Name => "group";`
	`30`	`+`
	`31`	`+ /// <inheritdoc/>`
	`32`	`+ IEnumerable<object> IHaveXmlChildren.Children => Children;`
`30`	`33`	`}`
`31`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`
`8`	`8`	`namespace Microsoft.Toolkit.Uwp.Notifications.Adaptive.Elements`
`9`	`9`	`{`
`10`		`- internal sealed class Element_AdaptiveSubgroup : IElementWithDescendants, IHaveXmlName, IHaveXmlNamedProperties`
	`10`	`+ internal sealed class Element_AdaptiveSubgroup : IElementWithDescendants, IHaveXmlName, IHaveXmlNamedProperties, IHaveXmlChildren`
`11`	`11`	`{`
`12`	`12`	`internal const AdaptiveSubgroupTextStacking DEFAULT_TEXT_STACKING = AdaptiveSubgroupTextStacking.Default;`
`13`	`13`
`@@ -54,6 +54,9 @@ public IEnumerable<object> Descendants()`
`54`	`54`	`/// <inheritdoc/>`
`55`	`55`	`string IHaveXmlName.Name => "subgroup";`
`56`	`56`
	`57`	`+ /// <inheritdoc/>`
	`58`	`+ IEnumerable<object> IHaveXmlChildren.Children => Children;`
	`59`	`+`
`57`	`60`	`/// <inheritdoc/>`
`58`	`61`	`IEnumerable<KeyValuePair<string, object>> IHaveXmlNamedProperties.EnumerateNamedProperties()`
`59`	`62`	`{`
Original file line number	Diff line number	Diff line change
`@@ -57,14 +57,15 @@ public static void Write(System.Xml.XmlWriter writer, object element)`
`57`	`57`	`{`
`58`	`58`	`continue;`
`59`	`59`	`}`
	`60`	`+ else if (p.Name == nameof(IHaveXmlChildren.Children) && element is IHaveXmlChildren && p.PropertyType == typeof(IEnumerable<object>))`
	`61`	`+ {`
	`62`	`+ continue;`
	`63`	`+ }`
`60`	`64`
`61`	`65`	`// Otherwise it's an element or collection of elements`
`62`	`66`	`else`
`63`	`67`	`{`
`64`		`- if (propertyValue != null)`
`65`		`- {`
`66`		`- elements.Add(propertyValue);`
`67`		`- }`
	`68`	`+ continue;`
`68`	`69`	`}`
`69`	`70`	`}`
`70`	`71`
`@@ -83,20 +84,14 @@ public static void Write(System.Xml.XmlWriter writer, object element)`
`83`	`84`	`}`
`84`	`85`	`}`
`85`	`86`
	`87`	`+ foreach (var child in (element as IHaveXmlChildren)?.Children ?? Enumerable.Empty<object>())`
	`88`	`+ {`
	`89`	`+ elements.Add(child);`
	`90`	`+ }`
	`91`	`+`
`86`	`92`	`// Then write children`
`87`	`93`	`foreach (object el in elements)`
`88`	`94`	`{`
`89`		`- // If it's a collection of children`
`90`		`- if (el is IEnumerable)`
`91`		`- {`
`92`		`- foreach (object child in el as IEnumerable)`
`93`		`- {`
`94`		`- Write(writer, child);`
`95`		`- }`
`96`		`-`
`97`		`- continue;`
`98`		`- }`
`99`		`-`
`100`	`95`	`// Otherwise just write the single element`
`101`	`96`	`Write(writer, el);`
`102`	`97`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,13 +2,18 @@`
`2`	`2`	`// The .NET Foundation licenses this file to you under the MIT license.`
`3`	`3`	`// See the LICENSE file in the project root for more information.`
`4`	`4`
	`5`	`+using System.Collections.Generic;`
	`6`	`+`
`5`	`7`	`namespace Microsoft.Toolkit.Uwp.Notifications`
`6`	`8`	`{`
`7`		`- internal sealed class Element_Tile : BaseElement, IHaveXmlName`
	`9`	`+ internal sealed class Element_Tile : BaseElement, IHaveXmlName, IHaveXmlChildren`
`8`	`10`	`{`
`9`	`11`	`public Element_TileVisual Visual { get; set; }`
`10`	`12`
`11`	`13`	`/// <inheritdoc/>`
`12`	`14`	`string IHaveXmlName.Name => "tile";`
	`15`	`+`
	`16`	`+ /// <inheritdoc/>`
	`17`	`+ IEnumerable<object> IHaveXmlChildren.Children => new[] { Visual };`
`13`	`18`	`}`
`14`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`namespace Microsoft.Toolkit.Uwp.Notifications`
`8`	`8`	`{`
`9`		`- internal sealed class Element_ToastActions : IHaveXmlName, IHaveXmlNamedProperties`
	`9`	`+ internal sealed class Element_ToastActions : IHaveXmlName, IHaveXmlNamedProperties, IHaveXmlChildren`
`10`	`10`	`{`
`11`	`11`	`internal const ToastSystemCommand DEFAULT_SYSTEM_COMMAND = ToastSystemCommand.None;`
`12`	`12`
`@@ -18,6 +18,9 @@ internal sealed class Element_ToastActions : IHaveXmlName, IHaveXmlNamedProperti`
`18`	`18`	`/// <inheritdoc/>`
`19`	`19`	`string IHaveXmlName.Name => "actions";`
`20`	`20`
	`21`	`+ /// <inheritdoc/>`
	`22`	`+ IEnumerable<object> IHaveXmlChildren.Children => Children;`
	`23`	`+`
`21`	`24`	`/// <inheritdoc/>`
`22`	`25`	`IEnumerable<KeyValuePair<string, object>> IHaveXmlNamedProperties.EnumerateNamedProperties()`
`23`	`26`	`{`