TraceListeners.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;

namespace System.Diagnostics
{
    /// <devdoc>
    /// <para>Provides a thread-safe list of <see cref='System.Diagnostics.TraceListenerCollection'/>. A thread-safe list is synchronized.</para>
    /// </devdoc>
    public class TraceListenerCollection : IList
    {
        private readonly List<TraceListener?> _list;

        internal TraceListenerCollection()
        {
            _list = new List<TraceListener?>(1);
        }

        /// <devdoc>
        /// <para>Gets or sets the <see cref='TraceListener'/> at
        ///    the specified index.</para>
        /// </devdoc>
        public TraceListener this[int i]
        {
            get
            {
                return _list[i]!;
            }

            set
            {
                InitializeListener(value);
                _list[i] = value;
            }
        }

        /// <devdoc>
        /// <para>Gets the first <see cref='System.Diagnostics.TraceListener'/> in the list with the specified name.</para>
        /// </devdoc>
        public TraceListener? this[string name]
        {
            get
            {
                foreach (TraceListener? listener in this)
                {
                    if (listener!.Name == name)
                        return listener;
                }
                return null;
            }
        }

        /// <devdoc>
        ///    <para>
        ///       Gets the number of listeners in the list.
        ///    </para>
        /// </devdoc>
        public int Count
        {
            get
            {
                return _list.Count;
            }
        }

        /// <devdoc>
        /// <para>Adds a <see cref='System.Diagnostics.TraceListener'/> to the list.</para>
        /// </devdoc>
        public int Add(TraceListener listener)
        {
            InitializeListener(listener);

            lock (TraceInternal.critSec)
            {
                return ((IList)_list).Add(listener);
            }
        }

        /// <devdoc>
        ///    <para>[To be supplied.]</para>
        /// </devdoc>
        public void AddRange(TraceListener[] value)
        {
            ArgumentNullException.ThrowIfNull(value);

            for (int i = 0; ((i) < (value.Length)); i = ((i) + (1)))
            {
                Add(value[i]);
            }
        }

        /// <devdoc>
        ///    <para>[To be supplied.]</para>
        /// </devdoc>
        public void AddRange(TraceListenerCollection value)
        {
            ArgumentNullException.ThrowIfNull(value);

            int currentCount = value.Count;
            for (int i = 0; i < currentCount; i = ((i) + (1)))
            {
                Add(value[i]);
            }
        }

        /// <devdoc>
        ///    <para>
        ///       Clears all the listeners from the
        ///       list.
        ///    </para>
        /// </devdoc>
        public void Clear()
        {
            _list.Clear();
        }

        /// <devdoc>
        ///    <para>Checks whether the list contains the specified
        ///       listener.</para>
        /// </devdoc>
        public bool Contains(TraceListener? listener)
        {
            return ((IList)this).Contains(listener);
        }

        /// <devdoc>
        /// <para>Copies a section of the current <see cref='System.Diagnostics.TraceListenerCollection'/> list to the specified array at the specified
        ///    index.</para>
        /// </devdoc>
        public void CopyTo(TraceListener[] listeners, int index)
        {
            ((ICollection)this).CopyTo((Array)listeners, index);
        }

        /// <devdoc>
        ///    <para>
        ///       Gets an enumerator for this list.
        ///    </para>
        /// </devdoc>
        public IEnumerator GetEnumerator()
        {
            return _list.GetEnumerator();
        }

        internal static void InitializeListener(TraceListener listener)
        {
            ArgumentNullException.ThrowIfNull(listener);

            listener.IndentSize = TraceInternal.IndentSize;
            listener.IndentLevel = TraceInternal.IndentLevel;
        }

        /// <devdoc>
        ///    <para>Gets the index of the specified listener.</para>
        /// </devdoc>
        public int IndexOf(TraceListener? listener)
        {
            return ((IList)this).IndexOf(listener);
        }

        /// <devdoc>
        ///    <para>Inserts the listener at the specified index.</para>
        /// </devdoc>
        public void Insert(int index, TraceListener listener)
        {
            InitializeListener(listener);
            lock (TraceInternal.critSec)
            {
                _list.Insert(index, listener);
            }
        }

        /// <devdoc>
        ///    <para>
        ///       Removes the specified instance of the <see cref='System.Diagnostics.TraceListener'/> class from the list.
        ///    </para>
        /// </devdoc>
        public void Remove(TraceListener? listener)
        {
            ((IList)this).Remove(listener);
        }

        /// <devdoc>
        ///    <para>Removes the first listener in the list that has the
        ///       specified name.</para>
        /// </devdoc>
        public void Remove(string name)
        {
            TraceListener? listener = this[name];
            if (listener != null)
                ((IList)this).Remove(listener);
        }

        /// <devdoc>
        /// <para>Removes the <see cref='System.Diagnostics.TraceListener'/> at the specified index.</para>
        /// </devdoc>
        public void RemoveAt(int index)
        {
            lock (TraceInternal.critSec)
            {
                _list.RemoveAt(index);
            }
        }

        /// <internalonly/>
        object? IList.this[int index]
        {
            get
            {
                return _list[index];
            }

            set
            {
                TraceListener? listener = value as TraceListener;
                if (listener == null)
                    throw new ArgumentException(SR.MustAddListener, nameof(value));
                InitializeListener(listener);
                _list[index] = listener;
            }
        }

        /// <internalonly/>
        bool IList.IsReadOnly
        {
            get
            {
                return false;
            }
        }

        /// <internalonly/>
        bool IList.IsFixedSize
        {
            get
            {
                return false;
            }
        }

        /// <internalonly/>
        int IList.Add(object? value)
        {
            TraceListener? listener = value as TraceListener;
            if (listener == null)
                throw new ArgumentException(SR.MustAddListener, nameof(value));

            InitializeListener(listener);

            lock (TraceInternal.critSec)
            {
                return ((IList)_list).Add(value);
            }
        }

        /// <internalonly/>
        bool IList.Contains(object? value)
        {
            return _list.Contains((TraceListener?)value);
        }

        /// <internalonly/>
        int IList.IndexOf(object? value)
        {
            return _list.IndexOf((TraceListener?)value);
        }

        /// <internalonly/>
        void IList.Insert(int index, object? value)
        {
            TraceListener? listener = value as TraceListener;
            if (listener == null)
                throw new ArgumentException(SR.MustAddListener, nameof(value));

            InitializeListener(listener);

            lock (TraceInternal.critSec)
            {
                _list.Insert(index, (TraceListener?)value);
            }
        }

        /// <internalonly/>
        void IList.Remove(object? value)
        {
            lock (TraceInternal.critSec)
            {
                _list.Remove((TraceListener)value!);
            }
        }

        /// <internalonly/>
        object ICollection.SyncRoot
        {
            get
            {
                return this;
            }
        }

        /// <internalonly/>
        bool ICollection.IsSynchronized
        {
            get
            {
                return true;
            }
        }

        /// <internalonly/>
        void ICollection.CopyTo(Array array, int index)
        {
            ((ICollection)_list).CopyTo(array, index);
        }
    }
}