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

namespace Developpez.Dotnet.Collections
{
    /// <summary>
    /// Fournit des méthodes d'extension pour manipuler des dictionnaires
    /// </summary>
    public static class DictionaryExtensions
    {
        /// <summary>
        /// Renvoie la valeur correspondant à la clé spécifiée si celle-ci existe, ou la valeur par défaut
        /// spécifiée si la clé n'existe pas
        /// </summary>
        /// <typeparam name="K">Type de la clé</typeparam>
        /// <typeparam name="V">Type de la valeur</typeparam>
        /// <param name="dictionary">Le dictionnaire à partir duquel renvoyer la valeur</param>
        /// <param name="key">La clé recherchée</param>
        /// <param name="defaultValue">La valeur par défaut à renvoyer si la clé n'existe pas</param>
        /// <returns>Si la clé existe, renvoie la valeur correspondante. Sinon, renvoie la valeur par défaut</returns>
        public static V GetValueOrDefault<K, V>(this IDictionary<K, V> dictionary, K key, V defaultValue)
        {
            V value;
            if (!dictionary.TryGetValue(key, out value))
                value = defaultValue;
            return value;
        }

        /// <summary>
        /// Renvoie la valeur correspondant à la clé spécifiée si celle-ci existe, ou la valeur par défaut
        /// du type de la valeur si la clé n'existe pas
        /// </summary>
        /// <typeparam name="K">Type de la clé</typeparam>
        /// <typeparam name="V">Type de la valeur</typeparam>
        /// <param name="dictionary">Le dictionnaire à partir duquel renvoyer la valeur</param>
        /// <param name="key">La clé recherchée</param>
        /// <returns>Si la clé existe, renvoie la valeur correspondante. Sinon, renvoie la valeur par défaut</returns>
        public static V GetValueOrDefault<K, V>(this IDictionary<K, V> dictionary, K key)
        {
            return dictionary.GetValueOrDefault(key, default(V));
        }

        /// <summary>
        /// Renvoie un wrapper en lecture seule pour un dictionnaire
        /// </summary>
        /// <typeparam name="K">Type de la clé</typeparam>
        /// <typeparam name="V">Type de la valeur</typeparam>
        /// <param name="dictionary">Le dictionnaire pour lequel renvoyer un wrapper</param>
        /// <returns>Un wrapper en lecture seule du dictionnaire</returns>
        public static ReadOnlyDictionary<K, V> AsReadOnly<K, V>(this IDictionary<K, V> dictionary)
        {
            return new ReadOnlyDictionary<K, V>(dictionary);
        }

        /// <summary>
        /// Renvoie un wrapper ou une copie en lecture seule pour un dictionnaire
        /// </summary>
        /// <typeparam name="K">Type de la clé</typeparam>
        /// <typeparam name="V">Type de la valeur</typeparam>
        /// <param name="dictionary">Le dictionnaire pour lequel renvoyer un wrapper</param>
        /// <param name="copy">true pour renvoyer une copie en lecture seule du dictionnaire ; false pour renvoyer simplement un wrapper du dictionnaire existant</param>
        /// <returns>Un wrapper ou une copie en lecture seule du dictionnaire</returns>
        public static ReadOnlyDictionary<K, V> AsReadOnly<K, V>(this IDictionary<K, V> dictionary, bool copy)
        {
            return new ReadOnlyDictionary<K, V>(dictionary, copy);
        }
    }
}