Comments

src/MoonSharp.Interpreter/DataStructs/Slice.cs

@@ -5,12 +5,23 @@ using System.Text;
 
 namespace MoonSharp.Interpreter.DataStructs
 {
-	public class Slice<T> : IEnumerable<T>
+	/// <summary>
+	/// Provides facility to create a "sliced" view over an existing IList<typeparamref name="T"/>
+	/// </summary>
+	/// <typeparam name="T">The type of the items contained in the collection</typeparam>
+	public class Slice<T> : IEnumerable<T>, IList<T>
 	{
 		IList<T> m_SourceList;
 		int m_From, m_Length;
 		bool m_Reversed;
 
+		/// <summary>
+		/// Initializes a new instance of the <see cref="Slice{T}"/> class.
+		/// </summary>
+		/// <param name="list">The list to apply the Slice view on</param>
+		/// <param name="from">From which index</param>
+		/// <param name="length">The length of the slice</param>
+		/// <param name="reversed">if set to <c>true</c> the view is in reversed order.</param>
 		public Slice(IList<T> list, int from, int length, bool reversed)
 		{
 			m_SourceList = list;
@@ -19,6 +30,11 @@ namespace MoonSharp.Interpreter.DataStructs
 			m_Reversed = reversed;
 		}
 
+		/// <summary>
+		/// Gets or sets the element at the specified index.
+		/// </summary>
+		/// <param name="index">The index.</param>
+		/// <returns></returns>
 		public T this[int index]
 		{
 			get 
@@ -31,21 +47,37 @@ namespace MoonSharp.Interpreter.DataStructs
 			}
 		}
 
+		/// <summary>
+		/// Gets the index from which the slice starts
+		/// </summary>
 		public int From
 		{
 			get { return m_From; }
 		}
 
+		/// <summary>
+		/// Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.
+		/// </summary>
+		/// <returns>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</returns>
 		public int Count
 		{
 			get { return m_Length; }
 		}
 
+		/// <summary>
+		/// Gets a value indicating whether this <see cref="Slice{T}"/> operates in a reversed direction.
+		/// </summary>
+		/// <value>
+		///   <c>true</c> if this <see cref="Slice{T}"/> operates in a reversed direction; otherwise, <c>false</c>.
+		/// </value>
 		public bool Reversed
 		{
 			get { return m_Reversed; }
 		}
 
+		/// <summary>
+		/// Calculates the real index in the underlying collection
+		/// </summary>
 		private int CalcRealIndex(int index)
 		{
 			if (index < 0 || index >= m_Length)
@@ -61,18 +93,33 @@ namespace MoonSharp.Interpreter.DataStructs
 			}
 		}
 
+		/// <summary>
+		/// Returns an enumerator that iterates through the collection.
+		/// </summary>
+		/// <returns>
+		/// A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
+		/// </returns>
 		public IEnumerator<T> GetEnumerator()
 		{
 			for (int i = 0; i < m_Length; i++)
 				yield return m_SourceList[CalcRealIndex(i)];
 		}
 
+		/// <summary>
+		/// Returns an enumerator that iterates through a collection.
+		/// </summary>
+		/// <returns>
+		/// An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.
+		/// </returns>
 		System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
 		{
 			for (int i = 0; i < m_Length; i++)
 				yield return m_SourceList[CalcRealIndex(i)];
 		}
 
+		/// <summary>
+		/// Converts to an array.
+		/// </summary>
 		public T[] ToArray()
 		{
 			T[] array = new T[m_Length];
@@ -83,6 +130,9 @@ namespace MoonSharp.Interpreter.DataStructs
 			return array;
 		}
 
+		/// <summary>
+		/// Converts to an list.
+		/// </summary>
 		public List<T> ToList()
 		{
 			List<T> list = new List<T>(m_Length);
@@ -94,5 +144,106 @@ namespace MoonSharp.Interpreter.DataStructs
 		}
 
 
+		/// <summary>
+		/// Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1" />.
+		/// </summary>
+		/// <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1" />.</param>
+		/// <returns>
+		/// The index of <paramref name="item" /> if found in the list; otherwise, -1.
+		/// </returns>
+		public int IndexOf(T item)
+		{
+			for (int i = 0; i < this.Count; i++)
+			{
+				if (this[i].Equals(item))
+					return i;
+			}
+			return -1;
+		}
+
+		/// <summary>
+		/// Inserts an item to the <see cref="T:System.Collections.Generic.IList`1" /> at the specified index.
+		/// </summary>
+		/// <param name="index">The zero-based index at which <paramref name="item" /> should be inserted.</param>
+		/// <param name="item">The object to insert into the <see cref="T:System.Collections.Generic.IList`1" />.</param>
+		/// <exception cref="System.InvalidOperationException">Slices are readonly</exception>
+		public void Insert(int index, T item)
+		{
+			throw new InvalidOperationException("Slices are readonly");
+		}
+
+		/// <summary>
+		/// Removes the <see cref="T:System.Collections.Generic.IList`1" /> item at the specified index.
+		/// </summary>
+		/// <param name="index">The zero-based index of the item to remove.</param>
+		/// <exception cref="System.InvalidOperationException">Slices are readonly</exception>
+		public void RemoveAt(int index)
+		{
+			throw new InvalidOperationException("Slices are readonly");
+		}
+
+		/// <summary>
+		/// Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1" />.
+		/// </summary>
+		/// <param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
+		/// <exception cref="System.InvalidOperationException">Slices are readonly</exception>
+		public void Add(T item)
+		{
+			throw new InvalidOperationException("Slices are readonly");
+		}
+
+		/// <summary>
+		/// Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1" />.
+		/// </summary>
+		/// <exception cref="System.InvalidOperationException">Slices are readonly</exception>
+		public void Clear()
+		{
+			throw new InvalidOperationException("Slices are readonly");
+		}
+
+		/// <summary>
+		/// Determines whether the <see cref="T:System.Collections.Generic.ICollection`1" /> contains a specific value.
+		/// </summary>
+		/// <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
+		/// <returns>
+		/// true if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, false.
+		/// </returns>
+		public bool Contains(T item)
+		{
+			return IndexOf(item) >= 0;
+		}
+
+		/// <summary>
+		/// Copies to.
+		/// </summary>
+		/// <param name="array">The array.</param>
+		/// <param name="arrayIndex">Index of the array.</param>
+		public void CopyTo(T[] array, int arrayIndex)
+		{
+			for (int i = 0; i < Count; i++)
+				array[i + arrayIndex] = this[i];
+		}
+
+		/// <summary>
+		/// Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only.
+		/// </summary>
+		/// <returns>true if the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only; otherwise, false.</returns>
+		public bool IsReadOnly
+		{
+			get { return true; }
+		}
+
+		/// <summary>
+		/// Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1" />.
+		/// </summary>
+		/// <param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
+		/// <returns>
+		/// true if <paramref name="item" /> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, false. This method also returns false if <paramref name="item" /> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1" />.
+		/// </returns>
+		/// <exception cref="System.InvalidOperationException">Slices are readonly</exception>
+		public bool Remove(T item)
+		{
+			throw new InvalidOperationException("Slices are readonly");
+		}
 	}
 }