RGB.NET/RGB.NET.Layout/LayoutExtension.cs

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

namespace RGB.NET.Layout;

/// <summary>
/// Offers some extensions and helper-methods for layout related things.
/// </summary>
public static class LayoutExtension
{
    /// <summary>
    /// Applies the specified layout to the specified device.
    /// </summary>
    /// <param name="layout">The layout to apply.</param>
    /// <param name="device">The device to apply the layout to.</param>
    /// <param name="createMissingLeds">Indicates if LEDs that are in the layout but not on the device should be created.</param>
    /// <param name="removeExcessiveLeds">Indicates if LEDS that are on the device but not in the layout should be removed.</param>
    public static void ApplyTo(this IDeviceLayout layout, IRGBDevice device, bool createMissingLeds = false, bool removeExcessiveLeds = false)
    {
        device.Size = new Size(layout.Width, layout.Height);
        device.DeviceInfo.LayoutMetadata = layout.CustomData;

        HashSet<LedId> ledIds = [];
        foreach (ILedLayout layoutLed in layout.Leds)
        {
            if (Enum.TryParse(layoutLed.Id, true, out LedId ledId))
            {
                ledIds.Add(ledId);

                Led? led = device[ledId];
                if ((led == null) && createMissingLeds)
                    led = device.AddLed(ledId, new Point(), new Size());

                if (led != null)
                {
                    led.Location = new Point(layoutLed.X, layoutLed.Y);
                    led.Size = new Size(layoutLed.Width, layoutLed.Height);
                    led.Shape = layoutLed.Shape;
                    led.ShapeData = layoutLed.ShapeData;
                    led.LayoutMetadata = layoutLed.CustomData;
                }
            }
        }

        if (removeExcessiveLeds)
        {
            List<LedId> ledsToRemove = device.Select(led => led.Id).Where(id => !ledIds.Contains(id)).ToList();
            foreach (LedId led in ledsToRemove)
                device.RemoveLed(led);
        }
    }

    /// <summary>
    /// Saves the specified layout to the given location.
    /// </summary>
    /// <param name="layout">The layout to save.</param>
    /// <param name="targetFile">The location to save to.</param>
    public static void Save(this IDeviceLayout layout, string targetFile)
    {
        using FileStream fs = new(targetFile, FileMode.Create);
        layout.Save(fs);
    }

    /// <summary>
    /// Saves the specified layout to the given stream.
    /// </summary>
    /// <param name="layout">The layout to save.</param>
    /// <param name="stream">The stream to save to.</param>
    public static void Save(this IDeviceLayout layout, Stream stream)
    {
        Type? customDataType = layout.CustomData?.GetType();
        Type? customLedDataType = layout.Leds.FirstOrDefault(x => x.CustomData != null)?.CustomData?.GetType();

        Type[] customTypes;
        if ((customDataType != null) && (customLedDataType != null))
            customTypes = [customDataType, customLedDataType];
        else if (customDataType != null)
            customTypes = [customDataType];
        else if (customLedDataType != null)
            customTypes = [customLedDataType];
        else
            customTypes = [];

        if (layout is DeviceLayout deviceLayout)
        {
            deviceLayout.InternalCustomData = deviceLayout.CustomData;

            foreach (ILedLayout led in deviceLayout.Leds)
                if (led is LedLayout ledLayout)
                    ledLayout.InternalCustomData = ledLayout.CustomData;
        }

        XmlSerializer serializer = new(typeof(DeviceLayout), null, customTypes, null, null);
        serializer.Serialize(stream, layout);
    }
}