using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Developpez.Dotnet.Collections
{
    /// <summary>
    /// Représente un dictionnaire dont toutes les clés sont supposées définies. Si une clé demandée
    /// n'existe pas dans le dictionnaire, elle est automatiquement créée avec la valeur par défaut ou
    /// le delegate spécifié
    /// </summary>
    /// <typeparam name="K">Type de la clé</typeparam>
    /// <typeparam name="V">Type de la valeur</typeparam>
    public class DefaultDictionary<K, V> : DictionaryBase<K, V>
    {
        private Func<K, V> _defaultValueGenerator;

        /// <summary>
        /// Initialise une nouvelle instance de DefaultDictionary&lt;T&gt;. Si une clé demandée est absente,
        /// elle est ajoutée avec la valeur par défaut du type de valeur du dictionnaire.
        /// </summary>
        public DefaultDictionary()
            : this(k => default(V))
        {
        }

        /// <summary>
        /// Initialise une nouvelle instance de DefaultDictionary&lt;T&gt;. Si une clé demandée est absente,
        /// elle est ajoutée avec la valeur par défaut spécifiée.
        /// </summary>
        /// <param name="defaultValue">La valeur par défaut à utiliser pour les clés absentes</param>
        public DefaultDictionary(V defaultValue)
            : this(k => defaultValue)
        {
        }

        /// <summary>
        /// Initialise une nouvelle instance de DefaultDictionary&lt;T&gt;. Si une clé demandée est absente,
        /// elle est ajoutée avec la valeur renvoyée par le delegate fourni en paramètre.
        /// </summary>
        /// <param name="defaultValueGenerator">Une fonction qui renvoie une valeur initiale pour une clé absente</param>
        public DefaultDictionary(Func<K, V> defaultValueGenerator)
            : base(new Dictionary<K, V>())
        {
            _defaultValueGenerator = defaultValueGenerator;
        }

        /// <summary>
        /// Obtient la valeur associée à la clé spécifiée. Si la clé n'existe pas, elle est ajoutée au
        /// dictionnaire avec une valeur par défaut.
        /// </summary>
        /// <param name="key">La clé pour laquelle retourner une valeur</param>
        /// <returns>La valeur correspondant à la clé</returns>
        public override V this[K key]
        {
            get
            {
                V value;
                if (!base.TryGetValue(key, out value))
                {
                    value = _defaultValueGenerator(key);
                    base[key] = value;
                }
                return value;
            }
            set
            {
                base[key] = value;
            }
        }

        /// <summary>
        /// Obtient la valeur associée à la clé spécifiée. Si la clé n'existe pas, elle est ajoutée au
        /// dictionnaire avec une valeur par défaut.
        /// </summary>
        /// <param name="key">La clé recherchée</param>
        /// <param name="value">Paramètre de sortie auquel la valeur trouvée est affectée</param>
        /// <returns>Toujours true</returns>
        public override bool TryGetValue(K key, out V value)
        {
            value = this[key];
            return true;
        }
    }
}