using Developpez.Dotnet.Language.Grammar;

namespace Developpez.Dotnet.Language
{
    /// <summary>
    /// Définit les méthodes implémentées par un convertisseur de nombre en toutes lettres
    /// </summary>
    public interface INumberSpeller
    {

        /// <summary>
        /// Convertit un nombre entier en toutes lettres.
        /// </summary>
        /// <param name="value">Nombre entier.</param>
        /// <param name="gender">Genre du nombre entier.</param>
        /// <param name="numeralAdjective">Nature de l'adjectif numéral.</param>
        /// <returns>Le nombre en toutes lettres.</returns>
        string Spell(long value, Gender gender, NumeralAdjective numeralAdjective);

        /// <summary>
        /// Convertit un nombre entier en toutes lettres.
        /// </summary>
        /// <param name="value">Nombre entier.</param>
        /// <param name="gender">Genre du nombre entier.</param>
        /// <param name="numeralAdjective">Nature de l'adjectif numéral.</param>
        /// <returns>Le nombre en toutes lettres.</returns>
        string Spell(ulong value, Gender gender, NumeralAdjective numeralAdjective);

        /// <summary>
        /// Convertit un nombre en virgule flottante en toutes lettres, avec le nombre de chiffres spécifié après la virgule.
        /// </summary>
        /// <param name="value">Nombre en virgule flottante</param>
        /// <param name="decimalPlaces">Nombre de chiffres après la virgule</param>
        /// <returns>Le nombre en toutes lettres</returns>
        string Spell(double value, int decimalPlaces);

        /// <summary>
        /// Convertit un nombre décimal en toutes lettres, avec le nombre de chiffres spécifié après la virgule.
        /// </summary>
        /// <param name="value">Nombre décimal</param>
        /// <param name="decimalPlaces">Nombre de chiffres après la virgule</param>
        /// <returns>Le nombre en toutes lettres</returns>
        string Spell(decimal value, int decimalPlaces);

        /// <summary>
        /// Convertit un montant en toutes lettres, avec la devise spécifiée.
        /// </summary>
        /// <param name="value">Montant en virgule flottante</param>
        /// <param name="currency">Devise à utiliser</param>
        /// <returns>Le montant en toutes lettres</returns>
        string SpellAmount(double value, CurrencyDescriptor currency);

        /// <summary>
        /// Convertit un montant en toutes lettres, avec la devise spécifiée.
        /// </summary>
        /// <param name="value">Montant décimal</param>
        /// <param name="currency">Devise à utiliser</param>
        /// <returns>Le montant en toutes lettres</returns>
        string SpellAmount(decimal value, CurrencyDescriptor currency);
    }
}