MPF/MPF.ExecutionContexts/Data/Input.cs

using System;

namespace MPF.ExecutionContexts.Data
{
    /// <summary>
    /// Represents a single input for an execution context
    /// </summary>
    public abstract class Input
    {
        #region Properties

        /// <summary>
        /// Primary name for the input
        /// </summary>
        public readonly string Name;

        /// <summary>
        /// Indicates if a value has been set
        /// </summary>
        public abstract bool ValueSet { get; }

        /// <summary>
        /// Verbose name for the input
        /// </summary>
        protected readonly string? _longName;

        /// <summary>
        /// Indicates if the value following is required or not
        /// </summary>
        protected readonly bool _required;

        #endregion

        #region Constructors

        /// <param name="name">Flag name / value</param>
        public Input(string name)
        {
            Name = name;
            _longName = null;
            _required = true;
        }

        /// <param name="name">Flag name / value</param>
        /// <param name="required">Indicates if a following value is required</param>
        public Input(string name, bool required)
        {
            Name = name;
            _longName = null;
            _required = required;
        }

        /// <param name="shortName">Flag name / value</param>
        /// <param name="longName">Verbose flag name / value</param>
        public Input(string shortName, string longName)
        {
            Name = shortName;
            _longName = longName;
            _required = true;
        }

        /// <param name="shortName">Flag name / value</param>
        /// <param name="longName">Verbose flag name / value</param>
        /// <param name="required">Indicates if a following value is required</param>
        public Input(string shortName, string longName, bool required)
        {
            Name = shortName;
            _longName = longName;
            _required = required;
        }

        #endregion

        #region Processors

        /// <summary>
        /// Process the current index, if possible
        /// </summary>
        /// <param name="parts">Parts array to be referenced</param>
        /// <param name="index">Reference to the position in the parts</param>
        /// <returns>True if a value could be determined, false otherwise</returns>
        public abstract bool Process(string[] parts, ref int index);

        #endregion

        #region Helpers

        /// <summary>
        /// Returns whether or not the selected item exists
        /// </summary>
        /// <param name="parts">Parts array to be referenced</param>
        /// <param name="index">Current index</param>
        /// <returns>True if the next item exists, false otherwise</returns>
        internal static bool DoesExist(string[] parts, int index)
            => index >= 0 && index < parts.Length;

        /// <summary>
        /// Get the trimmed value and multiplication factor from a value
        /// </summary>
        /// <param name="value">String value to treat as suffixed number</param>
        /// <returns>Trimmed value and multiplication factor</returns>
        internal static string ExtractFactorFromValue(string value, out long factor)
        {
            value = value.Trim('"');
            factor = 1;

            // Characters
            if (value.EndsWith("c", StringComparison.Ordinal))
            {
                factor = 1;
                value = value.TrimEnd('c');
            }

            // Words
            else if (value.EndsWith("w", StringComparison.Ordinal))
            {
                factor = 2;
                value = value.TrimEnd('w');
            }

            // Double Words
            else if (value.EndsWith("d", StringComparison.Ordinal))
            {
                factor = 4;
                value = value.TrimEnd('d');
            }

            // Quad Words
            else if (value.EndsWith("q", StringComparison.Ordinal))
            {
                factor = 8;
                value = value.TrimEnd('q');
            }

            // Kilobytes
            else if (value.EndsWith("k", StringComparison.Ordinal))
            {
                factor = 1024;
                value = value.TrimEnd('k');
            }

            // Megabytes
            else if (value.EndsWith("M", StringComparison.Ordinal))
            {
                factor = 1024 * 1024;
                value = value.TrimEnd('M');
            }

            // Gigabytes
            else if (value.EndsWith("G", StringComparison.Ordinal))
            {
                factor = 1024 * 1024 * 1024;
                value = value.TrimEnd('G');
            }

            return value;
        }

        /// <summary>
        /// Removes a leading 0x if it exists, case insensitive
        /// </summary>
        /// <param name="value">String with removed leading 0x</param>
        /// <returns></returns>
        internal static string RemoveHexIdentifier(string value)
        {
            if (value.Length <= 2)
                return value;
            if (value[0] != '0')
                return value;
            if (value[1] != 'x' && value[1] != 'X')
                return value;

            return value.Substring(2);
        }

        #endregion
    }

    /// <summary>
    /// Represents a single input for an execution context
    /// </summary>
    public abstract class Input<T> : Input
    {
        #region Properties

        /// <summary>
        /// Represents the last value stored
        /// </summary>
        public T? Value { get; protected set; }

        /// <inheritdoc/>
        public override bool ValueSet => Value != null;

        #endregion

        #region Constructors

        /// <inheritdoc/>
        public Input(string name)
            : base(name) { }

        /// <inheritdoc/>
        public Input(string name, bool required)
            : base(name, required) { }

        /// <inheritdoc/>
        public Input(string shortName, string longName)
            : base(shortName, longName) { }

        /// <inheritdoc/>
        public Input(string shortName, string longName, bool required)
            : base(shortName, longName, required) { }

        #endregion
    }
}