using System;
using System.Globalization;

namespace Ubisoft
{
    /// <summary>
    /// Utility class for dealing with short type.
    /// </summary>
    public static class HtShort
    {
        public static readonly IFormatProvider DefaultFormatProvider = HtTypes.DefaultFormatProvider;

        /// <summary>
        /// Converts the string representation of a number to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded.
        /// 
        /// This method uses NumberStyles.Integer and CultureInfo.InvariantCulture.
        /// Use this method when the string to convert comes from Content or persistence.
        /// </summary>
        /// <param name="s">A string containing a number to convert.</param>
        /// <param name="result">When this method returns, contains the 16-bit signed integer value equivalent of the number contained in s,
        ///                      if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or Empty,
        ///                      is not of the correct format, or represents a number less than MinValue or greater than MaxValue.
        ///                      This parameter is passed uninitialized; any value originally supplied in result will be overwritten.</param>
        /// <returns><c>true</c> if s was converted successfully; otherwise, <c>false</c></returns>
        public static bool TryParse(string s, out short result)
        {
            return TryParse(s, DefaultFormatProvider, out result);
        }

        /// <summary>
        /// Converts the string representation of a number to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded.
        /// 
        /// This method uses NumberStyles.Integer.
        /// </summary>
        /// <param name="s">A string containing a number to convert.</param>
        /// <param name="provider">An object that supplies culture-specific formatting information about s.</param>
        /// <param name="result">When this method returns, contains the 16-bit signed integer value equivalent of the number contained in s,
        ///                      if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or Empty,
        ///                      is not of the correct format, or represents a number less than MinValue or greater than MaxValue.
        ///                      This parameter is passed uninitialized; any value originally supplied in result will be overwritten.</param>
        /// <returns><c>true</c> if s was converted successfully; otherwise, <c>false</c></returns>
        public static bool TryParse(string s, IFormatProvider formatProvider, out short result)
        {
            return short.TryParse(s, NumberStyles.Integer, formatProvider, out result);
        }

        /// <summary>
        /// Converts the string representation of a number to its 16-bit signed integer equivalent.
        /// 
        /// This method uses NumberStyles.Integer and CultureInfo.InvariantCulture.
        /// Use this method when the string to convert comes from Content or persistence.
        /// </summary>
        /// <param name="s">A string containing a number to convert.</param>
        /// <returns>A 16-bit signed integer equivalent to the number specified in s
        ///          or
        ///         ArgumentNullException if s is null.
        ///         or
        ///         FormatException if s is not in a format compliant with CultureInfo.InvariantCulture.
        ///         or
        ///         OverflowException if s represents a number less than MinValue or greater than MaxValue or s includes non-zero, fractional digits.
        /// </returns>
        public static short Parse(string s)
        {
            return Parse(s, DefaultFormatProvider);
        }

        /// <summary>
        /// Converts the string representation of a number to its 16-bit signed integer equivalent.
        /// 
        /// This method uses NumberStyles.Integer.
        /// Use this method when the string to convert comes from Content or persistence.
        /// </summary>
        /// <param name="s">A string containing a number to convert.</param>
        /// <param name="provider">An object that supplies culture-specific formatting information about s.</param>
        /// <returns>A 16-bit signed integer equivalent to the number specified in s
        ///          or
        ///         ArgumentNullException if s is null.
        ///         or
        ///         FormatException if s is not in a format compliant with CultureInfo.InvariantCulture.
        ///         or
        ///         OverflowException if s represents a number less than MinValue or greater than MaxValue or s includes non-zero, fractional digits.
        /// </returns>
        public static short Parse(string s, IFormatProvider formatProvider)
        {
            return short.Parse(s, NumberStyles.Integer, formatProvider);
        }

        /// <summary>
        /// Converts the numeric value passed in to its equivalent string representation using CultureInfo.InvariantCulture.
        ///
        /// Use this method when you need the string returned to be independent from user's culture, typically when storing persistence, which
        /// will be loaded by using HtShort.Parse() or HtShort.TryParse() methods.
        /// </summary>
        /// <param name="value">A 16-bit signed integer.</param>
        /// <returns>The string representation of the value.</returns>
        public static string ToString(short value)
        {
            return value.ToString(DefaultFormatProvider);
        }
    }
}