CSGO-Projects/SteamShared/LoreSoft.MathExpressions/VariableDictionary.cs

using System;
using System.Collections.Generic;
using LoreSoft.MathExpressions.Properties;
using System.Globalization;
using System.Runtime.Serialization;
using System.Security.Permissions;

namespace LoreSoft.MathExpressions
{
    /// <summary>
    /// Class representing a collection of variable names and values.
    /// </summary>
    /// <remarks>
    /// Variable names can only contain letters, numbers and symbols are not allowed.
    /// </remarks>
    [Serializable]
    public class VariableDictionary : Dictionary<string, double>
    {
        private MathEvaluator _evaluator;

        /// <summary>Initializes a new instance of the <see cref="VariableDictionary"/> class.</summary>
        /// <param name="evaluator">The evaluator.</param>
        internal VariableDictionary(MathEvaluator evaluator)
            : base(StringComparer.OrdinalIgnoreCase)
        {
            _evaluator = evaluator;
            base.Add(MathEvaluator.AnswerVariable, 0);
            base.Add("pi", Math.PI);
            base.Add("e", Math.E);
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="VariableDictionary"/> class.
        /// </summary>
        /// <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> object containing the information required to serialize the <see cref="T:System.Collections.Generic.Dictionary`2"/>.</param>
        /// <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> structure containing the source and destination of the serialized stream associated with the <see cref="T:System.Collections.Generic.Dictionary`2"/>.</param>
        protected VariableDictionary(SerializationInfo info, StreamingContext context)
            : base(info, context)
        { }

        /// <summary>Adds the specified variable and value to the dictionary.</summary>
        /// <param name="name">The name of the variable to add.</param>
        /// <param name="value">The value of the variable.</param>
        /// <exception cref="ArgumentNullException">When variable name is null.</exception>
        /// <exception cref="ArgumentException">When variable name contains non-letters or the name exists in the <see cref="MathEvaluator.Functions"/> list.</exception>
        /// <seealso cref="MathEvaluator"/>
        /// <seealso cref="MathEvaluator.Variables"/>
        /// <seealso cref="MathEvaluator.Functions"/>
        public new void Add(string name, double value)
        {
            Validate(name);
            base.Add(name, value);
        }

        private void Validate(string name)
        {
            if (string.IsNullOrEmpty(name))
                throw new ArgumentNullException("name");

            if (_evaluator.IsFunction(name))
                throw new ArgumentException(
                    string.Format(CultureInfo.CurrentCulture,
                        Resources.VariableNameConflict, name), "name");

            for (int i = 0; i < name.Length; i++)
                if (!char.IsLetter(name[i]))
                    throw new ArgumentException(Resources.VariableNameContainsLetters, "name");
        }

        /// <summary>
        /// Implements the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface and returns the data needed to serialize the <see cref="T:System.Collections.Generic.Dictionary`2"/> instance.
        /// </summary>
        /// <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> object that contains the information required to serialize the <see cref="T:System.Collections.Generic.Dictionary`2"/> instance.</param>
        /// <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"/> structure that contains the source and destination of the serialized stream associated with the <see cref="T:System.Collections.Generic.Dictionary`2"/> instance.</param>
        [SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)]
        public override void GetObjectData(SerializationInfo info, StreamingContext context)
        {
            base.GetObjectData(info, context);
        }

    }
}