Error.cs

// Copyright 2005-2015 Giacomo Stelluti Scala & Contributors. All rights reserved. See License.md in the project root for license information.

using System;

namespace CommandLine
{
    /// <summary>
    /// Discriminator enumeration of <see cref="CommandLine.Error"/> derivates.
    /// </summary>
    public enum ErrorType
    {
        /// <summary>
        /// Value of <see cref="CommandLine.BadFormatTokenError"/> type.
        /// </summary>
        BadFormatTokenError,
        /// <summary>
        /// Value of <see cref="CommandLine.MissingValueOptionError"/> type.
        /// </summary>
        MissingValueOptionError,
        /// <summary>
        /// Value of <see cref="CommandLine.UnknownOptionError"/> type.
        /// </summary>
        UnknownOptionError,
        /// <summary>
        /// Value of <see cref="CommandLine.MissingRequiredOptionError"/> type.
        /// </summary>
        MissingRequiredOptionError,
        /// <summary>
        /// Value of <see cref="CommandLine.MutuallyExclusiveSetError"/> type.
        /// </summary>
        MutuallyExclusiveSetError,
        /// <summary>
        /// Value of <see cref="CommandLine.BadFormatConversionError"/> type.
        /// </summary>
        BadFormatConversionError,
        /// <summary>
        /// Value of <see cref="CommandLine.SequenceOutOfRangeError"/> type.
        /// </summary>
        SequenceOutOfRangeError,
        /// <summary>
        /// Value of <see cref="CommandLine.RepeatedOptionError"/> type.
        /// </summary>
        RepeatedOptionError,
        /// <summary>
        /// Value of <see cref="CommandLine.NoVerbSelectedError"/> type.
        /// </summary>
        NoVerbSelectedError,
        /// <summary>
        /// Value of <see cref="CommandLine.BadVerbSelectedError"/> type.
        /// </summary>
        BadVerbSelectedError,
        /// <summary>
        /// Value of <see cref="CommandLine.HelpRequestedError"/> type.
        /// </summary>
        HelpRequestedError,
        /// <summary>
        /// Value of <see cref="CommandLine.HelpVerbRequestedError"/> type.
        /// </summary>
        HelpVerbRequestedError,
        /// <summary>
        /// Value of <see cref="CommandLine.VersionRequestedError"/> type.
        /// </summary>
        VersionRequestedError,
        /// <summary>
        /// Value of <see cref="CommandLine.SetValueExceptionError"/> type.
        /// </summary>
        SetValueExceptionError
    }

    /// <summary>
    /// Base type of all errors.
    /// </summary>
    /// <remarks>All errors are defined within the system. There's no reason to create custom derivate types.</remarks>
    public abstract class Error : IEquatable<Error>
    {
        private readonly ErrorType tag;
        private readonly bool stopsProcessing;

        /// <summary>
        /// Initializes a new instance of the <see cref="CommandLine.Error"/> class.
        /// </summary>
        /// <param name="tag">Type discriminator tag.</param>
        /// <param name="stopsProcessing">Tells if error stops parsing process.</param>
        protected internal Error(ErrorType tag, bool stopsProcessing)
        {
            this.tag = tag;
            this.stopsProcessing = stopsProcessing;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="CommandLine.Error"/> class.
        /// </summary>
        /// <param name="tag">Type discriminator tag.</param>
        protected internal Error(ErrorType tag)
            : this(tag, false)
        {
        }

        /// <summary>
        /// Error type discriminator, defined as <see cref="CommandLine.ErrorType"/> enumeration.
        /// </summary>
        public ErrorType Tag
        {
            get { return tag; }
        }

        /// <summary>
        /// Tells if error stops parsing process.
        /// Filtered by <see cref="CommandLine.ErrorExtensions.OnlyMeaningfulOnes(System.Collections.Generic.IEnumerable{Error})"/>.
        /// </summary>
        public bool StopsProcessing
        {
            get { return stopsProcessing; }
        }

        /// <summary>
        /// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="System.Object"/>.
        /// </summary>
        /// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="System.Object"/>.</param>
        /// <returns><value>true</value> if the specified <see cref="System.Object"/> is equal to the current <see cref="System.Object"/>; otherwise, <value>false</value>.</returns>
        public override bool Equals(object obj)
        {
            var other = obj as Error;
            if (other != null)
            {
                return Equals(other);
            }

            return base.Equals(obj);
        }

        /// <summary>
        /// Serves as a hash function for a particular type.
        /// </summary>
        /// <remarks>A hash code for the current <see cref="System.Object"/>.</remarks>
        public override int GetHashCode()
        {
            return new { Tag, StopsProcessing }.GetHashCode();
        }

        /// <summary>
        /// Returns a value that indicates whether the current instance and a specified <see cref="CommandLine.Error"/> have the same value.
        /// </summary>
        /// <param name="other">The <see cref="CommandLine.Error"/> instance to compare.</param>
        /// <returns><value>true</value> if this instance of <see cref="CommandLine.Error"/> and <paramref name="other"/> have the same value; otherwise, <value>false</value>.</returns>
        public bool Equals(Error other)
        {
            if (other == null)
            {
                return false;
            }

            return Tag.Equals(other.Tag);
        }
    }

    /// <summary>
    /// Base type of all errors related to bad token detection.
    /// </summary>
    public abstract class TokenError : Error, IEquatable<TokenError>
    {
        private readonly string token;

        /// <summary>
        /// Initializes a new instance of the <see cref="CommandLine.TokenError"/> class.
        /// </summary>
        /// <param name="tag">Error type.</param>
        /// <param name="token">Problematic token.</param>
        protected internal TokenError(ErrorType tag, string token)
            : base(tag)
        {
            if (token == null) throw new ArgumentNullException("token");

            this.token = token;
        }

        /// <summary>
        /// The string containing the token text.
        /// </summary>
        public string Token
        {
            get { return token; }
        }

        /// <summary>
        /// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="System.Object"/>.
        /// </summary>
        /// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="System.Object"/>.</param>
        /// <returns><value>true</value> if the specified <see cref="System.Object"/> is equal to the current <see cref="System.Object"/>; otherwise, <value>false</value>.</returns>
        public override bool Equals(object obj)
        {
            var other = obj as TokenError;
            if (other != null)
            {
                return Equals(other);
            }

            return base.Equals(obj);
        }

        /// <summary>
        /// Serves as a hash function for a particular type.
        /// </summary>
        /// <remarks>A hash code for the current <see cref="System.Object"/>.</remarks>
        public override int GetHashCode()
        {
            return new {Tag, StopsProcessing, Token}.GetHashCode();
        }

        /// <summary>
        /// Returns a value that indicates whether the current instance and a specified <see cref="CommandLine.TokenError"/> have the same value.
        /// </summary>
        /// <param name="other">The <see cref="CommandLine.TokenError"/> instance to compare.</param>
        /// <returns><value>true</value> if this instance of <see cref="CommandLine.TokenError"/> and <paramref name="other"/> have the same value; otherwise, <value>false</value>.</returns>
        public bool Equals(TokenError other)
        {
            if (other == null)
            {
                return false;
            }

            return Tag.Equals(other.Tag) && Token.Equals(other.Token);
        }
    }

    /// <summary>
    /// Models an error generated when an invalid token is detected.
    /// </summary>
    public sealed class BadFormatTokenError : TokenError
    {
        internal BadFormatTokenError(string token)
            : base(ErrorType.BadFormatTokenError, token)
        {
        }
    }

    /// <summary>
    /// Base type of all erros with name information.
    /// </summary>
    public abstract class NamedError : Error, IEquatable<NamedError>
    {
        private readonly NameInfo nameInfo;

        /// <summary>
        /// Initializes a new instance of the <see cref="CommandLine.NamedError"/> class.
        /// </summary>
        /// <param name="tag">Error type.</param>
        /// <param name="nameInfo">Problematic name.</param>

        protected internal NamedError(ErrorType tag, NameInfo nameInfo)
            : base(tag)
        {
            this.nameInfo = nameInfo;
        }

        /// <summary>
        /// Name information relative to this error instance.
        /// </summary>
        public NameInfo NameInfo
        {
            get { return nameInfo; }
        }

        /// <summary>
        /// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="System.Object"/>.
        /// </summary>
        /// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="System.Object"/>.</param>
        /// <returns><value>true</value> if the specified <see cref="System.Object"/> is equal to the current <see cref="System.Object"/>; otherwise, <value>false</value>.</returns>
        public override bool Equals(object obj)
        {
            var other = obj as NamedError;
            if (other != null)
            {
                return Equals(other);
            }

            return base.Equals(obj);
        }

        /// <summary>
        /// Serves as a hash function for a particular type.
        /// </summary>
        /// <remarks>A hash code for the current <see cref="System.Object"/>.</remarks>
        public override int GetHashCode()
        {
            return new {Tag, StopsProcessing, NameInfo}.GetHashCode();
        }

        /// <summary>
        /// Returns a value that indicates whether the current instance and a specified <see cref="CommandLine.NamedError"/> have the same value.
        /// </summary>
        /// <param name="other">The <see cref="CommandLine.NamedError"/> instance to compare.</param>
        /// <returns><value>true</value> if this instance of <see cref="CommandLine.NamedError"/> and <paramref name="other"/> have the same value; otherwise, <value>false</value>.</returns>
        public bool Equals(NamedError other)
        {
            if (other == null)
            {
                return false;
            }

            return Tag.Equals(other.Tag) && NameInfo.Equals(other.NameInfo);
        }
    }

    /// <summary>
    /// Models an error generated when an option lacks its value.
    /// </summary>
    public sealed class MissingValueOptionError : NamedError
    {
        internal MissingValueOptionError(NameInfo nameInfo)
            : base(ErrorType.MissingValueOptionError, nameInfo)
        {
        }
    }

    /// <summary>
    /// Models an error generated when an unknown option is detected.
    /// </summary>
    public sealed class UnknownOptionError : TokenError
    {
        internal UnknownOptionError(string token)
            : base(ErrorType.UnknownOptionError, token)
        {
        }
    }

    /// <summary>
    /// Models an error generated when a required option is required.
    /// </summary>
    public sealed class MissingRequiredOptionError : NamedError
    {
        internal MissingRequiredOptionError(NameInfo nameInfo)
            : base(ErrorType.MissingRequiredOptionError, nameInfo)
        {
        }
    }

    /// <summary>
    /// Models an error generated when a an option from another set is defined.
    /// </summary>
    public sealed class MutuallyExclusiveSetError : NamedError
    {
        private readonly string setName;

        internal MutuallyExclusiveSetError(NameInfo nameInfo, string setName)
            : base(ErrorType.MutuallyExclusiveSetError, nameInfo)
        {
            this.setName = setName;
        }

        /// <summary>
        /// Option's set name.
        /// </summary>
        public string SetName
        {
            get { return setName; }
        }
    }

    /// <summary>
    /// Models an error generated when a value conversion fails.
    /// </summary>
    public sealed class BadFormatConversionError : NamedError
    {
        internal BadFormatConversionError(NameInfo nameInfo)
            : base(ErrorType.BadFormatConversionError, nameInfo)
        {
        }
    }

    /// <summary>
    /// Models an error generated when a sequence value lacks elements.
    /// </summary>
    public sealed class SequenceOutOfRangeError : NamedError
    {
        internal SequenceOutOfRangeError(NameInfo nameInfo)
            : base(ErrorType.SequenceOutOfRangeError, nameInfo)
        {
        }
    }

    /// <summary>
    /// Models an error generated when an option is repeated two or more times.
    /// </summary>
    public sealed class RepeatedOptionError : NamedError
    {
        internal RepeatedOptionError(NameInfo nameInfo)
            : base(ErrorType.RepeatedOptionError, nameInfo)
        {
        }
    }

    /// <summary>
    /// Models an error generated when an unknown verb is detected.
    /// </summary>
    public sealed class BadVerbSelectedError : TokenError
    {
        internal BadVerbSelectedError(string token)
            : base(ErrorType.BadVerbSelectedError, token)
        {
        }
    }

    /// <summary>
    /// Models an error generated when a user explicitly requests help.
    /// </summary>
    public sealed class HelpRequestedError : Error
    {
        internal HelpRequestedError()
            : base(ErrorType.HelpRequestedError, true)
        {
        }
    }

    /// <summary>
    /// Models an error generated when a user explicitly requests help in verb commands scenario.
    /// </summary>
    public sealed class HelpVerbRequestedError : Error
    {
        private readonly string verb;
        private readonly Type type;
        private readonly bool matched;

        internal HelpVerbRequestedError(string verb, Type type, bool matched)
            : base(ErrorType.HelpVerbRequestedError, true)
        {
            this.verb = verb;
            this.type = type;
            this.matched = matched;
        }

        /// <summary>
        /// Verb command string.
        /// </summary>
        public string Verb
        {
            get { return verb; }
        }

        /// <summary>
        /// <see cref="System.Type"/> of verb command.
        /// </summary>
        public Type Type
        {
            get { return type; }
        }

        /// <summary>
        /// <value>true</value> if verb command is found; otherwise <value>false</value>.
        /// </summary>
        public bool Matched
        {
            get { return matched; }
        }
    }

    /// <summary>
    /// Models an error generated when no verb is selected.
    /// </summary>
    public sealed class NoVerbSelectedError : Error
    {
        internal NoVerbSelectedError()
            : base(ErrorType.NoVerbSelectedError)
        {
        }
    }

    /// <summary>
    /// Models an error generated when a user explicitly requests version.
    /// </summary>
    public sealed class VersionRequestedError : Error
    {
        internal VersionRequestedError()
            : base(ErrorType.VersionRequestedError, true)
        {
        }
    }

    /// <summary>
    /// Models as error generated when exception is thrown at Property.SetValue
    /// </summary>
    public sealed class SetValueExceptionError : NamedError
    {
        private readonly Exception exception;
        private readonly object value;

        internal SetValueExceptionError(NameInfo nameInfo, Exception exception, object value)
            : base(ErrorType.SetValueExceptionError, nameInfo)
        {
            this.exception = exception;
            this.value = value;
        }

        /// <summary>
        /// The expection thrown from Property.SetValue
        /// </summary>
        public Exception Exception
        {
            get { return exception; }
        }

        /// <summary>
        /// The value that had to be set to the property
        /// </summary>
        public object Value
        {
            get { return value; }
        }

    }
}