// <file>
//     <copyright see="prj:///doc/copyright.txt"/>
//     <license see="prj:///doc/license.txt"/>
//     <owner name="Andrea Paatz" email="andrea@icsharpcode.net"/>
//     <version value="$version"/>
// </file>


namespace SharpDevelop.Internal.Parser
{

    using System;
    using System.Collections;
	
    /// <summary>
    ///     <para>
    ///       A collection that stores <see cref='.Token'/> objects.
    ///    </para>
    /// </summary>
    /// <seealso cref='.TokenCollection'/>
    [Serializable()]
    public class TokenCollection : CollectionBase {

        
        /// <summary>
        ///     <para>
        ///       Initializes a new instance of <see cref='.TokenCollection'/>.
        ///    </para>
        /// </summary>
        public TokenCollection() {

        }

        

        /// <summary>
        ///     <para>
        ///       Initializes a new instance of <see cref='.TokenCollection'/> based on another <see cref='.TokenCollection'/>.
        ///    </para>
        /// </summary>
        /// <param name='value'>
        ///       A <see cref='.TokenCollection'/> from which the contents are copied
        /// </param>

        public TokenCollection(TokenCollection value) {

            this.AddRange(value);
        }

        

        /// <summary>
        ///     <para>
        ///       Initializes a new instance of <see cref='.TokenCollection'/> containing any array of <see cref='.Token'/> objects.
        ///    </para>
        /// </summary>
        /// <param name='value'>
        ///       A array of <see cref='.Token'/> objects with which to intialize the collection
        /// </param>

        public TokenCollection(Token[] value) {
            this.AddRange(value);
        }

       
        /// <summary>
        /// <para>Represents the entry at the specified index of the <see cref='.Token'/>.</para>
        /// </summary>
        /// <param name='index'><para>The zero-based index of the entry to locate in the collection.</para></param>
        /// <value>
        ///    <para> The entry at the specified index of the collection.</para>
        /// </value>
        /// <exception cref='System.ArgumentOutOfRangeException'><paramref name='index'/> is outside the valid range of indexes for the collection.</exception>
        public Token this[int index] {

            get {

                return ((Token)(List[index]));

            }

            set {

                List[index] = value;

            }

        }

        

        /// <summary>
        ///    <para>Adds a <see cref='.Token'/> with the specified value to the 
        ///    <see cref='.TokenCollection'/> .</para>
        /// </summary>
        /// <param name='value'>The <see cref='.Token'/> to add.</param>
        /// <returns>
        ///    <para>The index at which the new element was inserted.</para>
        /// </returns>
        /// <seealso cref='.TokenCollection.AddRange'/>
        public int Add(Token value) {
            return List.Add(value);
        }

        

        /// <summary>
        /// <para>Copies the elements of an array to the end of the <see cref='.TokenCollection'/>.</para>
        /// </summary>
        /// <param name='value'>
        ///    An array of type <see cref='.Token'/> containing the objects to add to the collection.
        /// </param>
        /// <returns>
        ///   <para>None.</para>
        /// </returns>
        /// <seealso cref='.TokenCollection.Add'/>
        public void AddRange(Token[] value) {

            for (int i = 0; (i < value.Length); i = (i + 1)) {
                this.Add(value[i]);
            }
        }
       
        /// <summary>
        ///     <para>
        ///       Adds the contents of another <see cref='.TokenCollection'/> to the end of the collection.
        ///    </para>
        /// </summary>
        /// <param name='value'>
        ///    A <see cref='.TokenCollection'/> containing the objects to add to the collection.
        /// </param>
        /// <returns>
        ///   <para>None.</para>
        /// </returns>
        /// <seealso cref='.TokenCollection.Add'/>
        public void AddRange(TokenCollection value) {
            for (int i = 0; (i < value.Count); i = (i + 1)) {
                this.Add(value[i]);
            }
        }
        

        /// <summary>
        /// <para>Gets a value indicating whether the 
        ///    <see cref='.TokenCollection'/> contains the specified <see cref='.Token'/>.</para>
        /// </summary>
        /// <param name='value'>The <see cref='.Token'/> to locate.</param>
        /// <returns>
        /// <para><see langword='true'/> if the <see cref='.Token'/> is contained in the collection; 
        ///   otherwise, <see langword='false'/>.</para>
        /// </returns>
        /// <seealso cref='.TokenCollection.IndexOf'/>
        public bool Contains(Token value) {
            return List.Contains(value);
        }
        
        /// <summary>
        /// <para>Copies the <see cref='.TokenCollection'/> values to a one-dimensional <see cref='System.Array'/> instance at the 
        ///    specified index.</para>
        /// </summary>
        /// <param name='array'><para>The one-dimensional <see cref='System.Array'/> that is the destination of the values copied from <see cref='.TokenCollection'/> .</para></param>
        /// <param name='index'>The index in <paramref name='array'/> where copying begins.</param>
        /// <returns>
        ///   <para>None.</para>
        /// </returns>
        /// <exception cref='System.ArgumentException'><para><paramref name='array'/> is multidimensional.</para> <para>-or-</para> <para>The number of elements in the <see cref='.TokenCollection'/> is greater than the available space between <paramref name='arrayIndex'/> and the end of <paramref name='array'/>.</para></exception>
        /// <exception cref='System.ArgumentNullException'><paramref name='array'/> is <see langword='null'/>. </exception>
        /// <exception cref='System.ArgumentOutOfRangeException'><paramref name='arrayIndex'/> is less than <paramref name='array'/>'s lowbound. </exception>
        /// <seealso cref='System.Array'/>
        public void CopyTo(Token[] array, int index) {
            List.CopyTo(array, index);
        }

        
        /// <summary>
        ///    <para>Returns the index of a <see cref='.Token'/> in 
        ///       the <see cref='.TokenCollection'/> .</para>
        /// </summary>
        /// <param name='value'>The <see cref='.Token'/> to locate.</param>
        /// <returns>
        /// <para>The index of the <see cref='.Token'/> of <paramref name='value'/> in the 
        /// <see cref='.TokenCollection'/>, if found; otherwise, -1.</para>
        /// </returns>
        /// <seealso cref='.TokenCollection.Contains'/>
        public int IndexOf(Token value) {
            return List.IndexOf(value);
        }
        

        /// <summary>
        /// <para>Inserts a <see cref='.Token'/> into the <see cref='.TokenCollection'/> at the specified index.</para>
        /// </summary>
        /// <param name='index'>The zero-based index where <paramref name='value'/> should be inserted.</param>
        /// <param name=' value'>The <see cref='.Token'/> to insert.</param>
        /// <returns><para>None.</para></returns>
        /// <seealso cref='.TokenCollection.Add'/>
        public void Insert(int index, Token value) {

            List.Insert(index, value);

        }

        
        /// <summary>
        ///    <para>Returns an enumerator that can iterate through 
        ///       the <see cref='.TokenCollection'/> .</para>
        /// </summary>
        /// <returns><para>None.</para></returns>
        /// <seealso cref='System.Collections.IEnumerator'/>
        public new TokenEnumerator GetEnumerator() {
            return new TokenEnumerator(this);
        }

        
        /// <summary>
        ///    <para> Removes a specific <see cref='.Token'/> from the 
        ///    <see cref='.TokenCollection'/> .</para>
        /// </summary>
        /// <param name='value'>The <see cref='.Token'/> to remove from the <see cref='.TokenCollection'/> .</param>
        /// <returns><para>None.</para></returns>
        /// <exception cref='System.ArgumentException'><paramref name='value'/> is not found in the Collection. </exception>
        public void Remove(Token value) {
            List.Remove(value);
        }

        public class TokenEnumerator : object, IEnumerator {
            private IEnumerator baseEnumerator;
            private IEnumerable temp;

            public TokenEnumerator(TokenCollection mappings) {
                this.temp = ((IEnumerable)(mappings));
                this.baseEnumerator = temp.GetEnumerator();
            }

            public Token Current {
                get {
                    return ((Token)(baseEnumerator.Current));
                }
            }

            object IEnumerator.Current {
                get {
                    return baseEnumerator.Current;
                }
            }

            

            public bool MoveNext() {
                return baseEnumerator.MoveNext();
            }

            

            bool IEnumerator.MoveNext() {
                return baseEnumerator.MoveNext();
            }

            public void Reset() {
                baseEnumerator.Reset();
            }

            void IEnumerator.Reset() {
                baseEnumerator.Reset();
            }
        }
    }
}
