Hastlayer-SDK

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Linq;

namespace Hast.Communication.Exceptions;

/// <summary>
/// Exception thrown when there is a mismatch between the results of the hardware and standard software invocation.
/// </summary>
[SuppressMessage(
    "Major Code Smell",
    "S3925:\"ISerializable\" should be implemented correctly",
    Justification = "This exception shouldn't be serialized.")]
public class HardwareExecutionResultMismatchException : Exception
{
    public IEnumerable<Mismatch> Mismatches { get; }
    public int CellCount { get; }
    public override string Message => ToString();

    public HardwareExecutionResultMismatchException(IEnumerable<Mismatch> mismatches, int cellCount)
    {
        Mismatches = mismatches;
        CellCount = cellCount;
    }

    public HardwareExecutionResultMismatchException()
    {
    }

    public HardwareExecutionResultMismatchException(string message)
        : base(message)
    {
    }

    public HardwareExecutionResultMismatchException(string message, Exception innerException)
        : base(message, innerException)
    {
    }

    public override string ToString() =>
        "The hardware and software executions resulted in different results: " +
        string.Join("; ", Mismatches.Select(mismatch => mismatch.ToString()));

    [DebuggerDisplay("{ToString()}")]
    public class Mismatch
    {
        public int ResultMemoryIndex { get; }
        public IReadOnlyList<byte> HardwareResult { get; }
        public IReadOnlyList<byte> SoftwareResult { get; }

        public Mismatch(int resultMemoryIndex, byte[] hardwareResult, byte[] softwareResult)
        {
            ResultMemoryIndex = resultMemoryIndex;
            HardwareResult = hardwareResult;
            SoftwareResult = softwareResult;
        }

        public override string ToString() =>
            HardwareResult == null || SoftwareResult == null ?
                "The hardware or software result was not supplied." :
                $"index: {ResultMemoryIndex}, " +
                    $"hardware result: {{ {string.Join(", ", HardwareResult)} }} " +
                    $"{{ {string.Join(", ", HardwareResult.Select(result => Convert.ToString(result, 16)))} }}, " +
                    $"software result: {{ {string.Join(", ", SoftwareResult)} }} " +
                    $"{{ {string.Join(", ", SoftwareResult.Select(result => Convert.ToString(result, 16)))} }}";
    }

    [DebuggerDisplay("{ToString()}")]
    public class LengthMismatch : Mismatch
    {
        public int HardwareCellCount { get; }
        public int SoftwareCellCount { get; }

        public LengthMismatch(int hardwareCellCount, int softwareCellCount, int overflowIndex, byte[] hardwareResult, byte[] softwareResult)
            : base(overflowIndex, hardwareResult, softwareResult)
        {
            HardwareCellCount = hardwareCellCount;
            SoftwareCellCount = softwareCellCount;
        }

        public override string ToString() =>
            "The hardware and software results don't have the same length. The hardware result is " +
            HardwareCellCount + " cell(s) and the software result is " + SoftwareCellCount + ".";
    }
}