DeviceLayout.cs

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.IO;
using System.Linq;
using System.Xml;
using System.Xml.Serialization;
using RGB.NET.Core;

namespace RGB.NET.Layout;

/// <summary>
/// Represents the serializable layout of a <see cref="IRGBDevice"/>.
/// </summary>
[Serializable]
[XmlRoot("Device")]
public class DeviceLayout : IDeviceLayout
{
    #region Properties & Fields

    /// <summary>
    /// Gets or sets the name of the <see cref="DeviceLayout"/>.
    /// </summary>
    [XmlElement("Name")]
    public string? Name { get; set; }

    /// <summary>
    /// Gets or sets the description of the <see cref="DeviceLayout"/>.
    /// </summary>
    [XmlElement("Description")]
    public string? Description { get; set; }

    /// <summary>
    /// Gets or sets the author of the <see cref="DeviceLayout"/>.
    /// </summary>
    [XmlElement("Author")]
    public string? Author { get; set; }

    /// <summary>
    /// Gets or sets the <see cref="RGBDeviceType"/> of the <see cref="DeviceLayout"/>.
    /// </summary>
    [XmlElement("Type")]
    public RGBDeviceType Type { get; set; }

    /// <summary>
    /// Gets or sets the vendor of the <see cref="DeviceLayout"/>.
    /// </summary>
    [XmlElement("Vendor")]
    public string? Vendor { get; set; }

    /// <summary>
    /// Gets or sets the model of the <see cref="DeviceLayout"/>.
    /// </summary>
    [XmlElement("Model")]
    public string? Model { get; set; }

    /// <summary>
    /// Gets or sets the <see cref="Core.Shape"/> of the <see cref="DeviceLayout"/>.
    /// </summary>
    [XmlElement("Shape")]
    [DefaultValue(Shape.Rectangle)]
    public Shape Shape { get; set; } = Shape.Rectangle;

    /// <summary>
    /// Gets or sets the width of the <see cref="DeviceLayout"/>.
    /// </summary>
    [XmlElement("Width")]
    public float Width { get; set; }

    /// <summary>
    /// Gets or sets the height of the <see cref="DeviceLayout"/>.
    /// </summary>
    [XmlElement("Height")]
    public float Height { get; set; }

    /// <summary>
    /// Gets or sets the width of one 'unit' used for the calculation of led positions and sizes.
    /// </summary>
    [XmlElement("LedUnitWidth")]
    [DefaultValue(19.0)]
    public float LedUnitWidth { get; set; } = 19.0f;

    /// <summary>
    /// Gets or sets the height of one 'unit' used for the calculation of led positions and sizes.
    /// </summary>
    [XmlElement("LedUnitHeight")]
    [DefaultValue(19.0)]
    public float LedUnitHeight { get; set; } = 19.0f;

    /// <summary>
    /// Gets or sets the internal list of led layouts.
    /// Normally you should use <see cref="Leds"/> to access this data.
    /// </summary>
    [XmlArray("Leds")]
    public List<LedLayout> InternalLeds { get; set; } = [];

    /// <summary>
    /// Gets or sets a list of <see cref="LedLayout"/> representing all the <see cref="Led"/> of the <see cref="DeviceLayout"/>.
    /// </summary>
    [XmlIgnore]
    public IEnumerable<ILedLayout> Leds => InternalLeds;

    /// <summary>
    /// Gets or sets the internal custom data of this layout.
    /// Normally you should use <see cref="CustomData"/> to access or set this data.
    /// </summary>
    [XmlElement("CustomData")]
    public object? InternalCustomData { get; set; }

    /// <inheritdoc />
    [XmlIgnore]
    public object? CustomData { get; set; }

    #endregion

    #region Methods

    /// <summary>
    /// Creates a new <see cref="DeviceLayout"/> from the specified xml.
    /// </summary>
    /// <param name="stream">The stream that contains the layout to be loaded.</param>
    /// <param name="customDeviceDataType">The type of the custom data.</param>
    /// <param name="customLedDataType">The type of the custom data of the leds.</param>
    /// <returns>The deserialized <see cref="DeviceLayout"/>.</returns>
    public static DeviceLayout? Load(Stream stream, Type? customDeviceDataType = null, Type? customLedDataType = null)
    {
        try
        {
            XmlSerializer serializer = new(typeof(DeviceLayout));
            DeviceLayout? layout = serializer.Deserialize(stream) as DeviceLayout;
            if (layout != null)
                layout.CustomData = layout.GetCustomData(layout.InternalCustomData, customDeviceDataType);

            if (layout?.InternalLeds != null)
            {
                LedLayout? lastLed = null;
                foreach (LedLayout led in layout.InternalLeds)
                {
                    led.CalculateValues(layout, lastLed);
                    lastLed = led;

                    led.CustomData = layout.GetCustomData(led.InternalCustomData, customLedDataType);
                }
            }

            return layout;
        }
        catch
        {
            return null;
        }
    }

    /// <summary>
    /// Creates a new <see cref="DeviceLayout"/> from the specified xml.
    /// </summary>
    /// <param name="path">The path to the xml file.</param>
    /// <param name="customDeviceDataType">The type of the custom data.</param>
    /// <param name="customLedDataType">The type of the custom data of the leds.</param>
    /// <returns>The deserialized <see cref="DeviceLayout"/>.</returns>
    public static DeviceLayout? Load(string path, Type? customDeviceDataType = null, Type? customLedDataType = null)
    {
        if (!File.Exists(path)) return null;

        using Stream stream = File.OpenRead(path);
        return Load(stream, customDeviceDataType, customLedDataType);
    }

    /// <summary>
    /// Gets the deserialized custom data.
    /// </summary>
    /// <param name="customData">The internal custom data node.</param>
    /// <param name="type">The type of the custom data.</param>
    /// <returns>The deserialized custom data object.</returns>
    protected virtual object? GetCustomData(object? customData, Type? type)
    {
        XmlNode? node = (customData as XmlNode) ?? (customData as IEnumerable<XmlNode>)?.FirstOrDefault(x => x.ParentNode != null)?.ParentNode; //HACK DarthAffe 16.01.2021: This gives us the CustomData-Node
        if ((node == null) || (type == null)) return null;

        using MemoryStream ms = new();
        using StreamWriter writer = new(ms);

        writer.Write(node.OuterXml);
        writer.Flush();
        ms.Seek(0, SeekOrigin.Begin);

        return new XmlSerializer(type).Deserialize(ms);
    }

    #endregion
}