From 3f8e571b7887758514645c46b2b26d7c3fc82e45 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Mon, 18 Jul 2011 02:01:12 +0100
Subject: Use a standard generic system stack for the undo/redo stacks instead
 of our own homebrew.

system stack also uses an array, so no performance penalty.
Also exposes undo count and adds a test assertion for correct undo count after resize
---
 OpenSim/Framework/UndoStack.cs | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

(limited to 'OpenSim/Framework')

diff --git a/OpenSim/Framework/UndoStack.cs b/OpenSim/Framework/UndoStack.cs
index fde63b1..8f8849d 100644
--- a/OpenSim/Framework/UndoStack.cs
+++ b/OpenSim/Framework/UndoStack.cs
@@ -45,59 +45,96 @@ namespace OpenSim.Framework
             m_Undos = new T[capacity + 1];
         }
 
+        /// <summary>
+        /// Is the stack full?
+        /// </summary>
         public bool IsFull
         {
-            get { return m_new == m_old; }
+            get
+            {
+                // If the old and new pointers are in the same place then all stack slots are occupied.
+                return m_new == m_old;
+            }
         }
 
+        /// <summary>
+        /// Capacity of the stack.
+        /// </summary>
         public int Capacity
         {
             get { return m_Undos.Length - 1; }
         }
 
+        /// <summary>
+        /// Return the number of undos on the stack.
+        /// </summary>
         public int Count
         {
             get
             {
                 int count = m_new - m_old - 1;
+
                 if (count < 0)
                     count += m_Undos.Length;
+
                 return count;
             }
         }
 
+        /// <summary>
+        /// Push a new undo onto the stack.
+        /// </summary>
+        /// <param name="item"></param>
         public void Push(T item)
         {
             if (IsFull)
             {
                 m_old++;
+
                 if (m_old >= m_Undos.Length)
                     m_old -= m_Undos.Length;
             }
+
             if (++m_new >= m_Undos.Length)
                 m_new -= m_Undos.Length;
+
             m_Undos[m_new] = item;
         }
 
+        /// <summary>
+        /// Pop and item from the top of the undo stack.
+        /// </summary>
+        /// <returns></returns>
         public T Pop()
         {
             if (Count > 0)
             {
                 T deleted = m_Undos[m_new];
                 m_Undos[m_new--] = default(T);
+
                 if (m_new < 0)
                     m_new += m_Undos.Length;
+
                 return deleted;
             }
             else
+            {
                 throw new InvalidOperationException("Cannot pop from empty stack");
+            }
         }
 
+        /// <summary>
+        /// Peek at the undo on the top of the stack.
+        /// </summary>
+        /// <returns></returns>
         public T Peek()
         {
             return m_Undos[m_new];
         }
 
+        /// <summary>
+        /// Clear the stack.
+        /// </summary>
         public void Clear()
         {
             if (Count > 0)
@@ -106,6 +143,7 @@ namespace OpenSim.Framework
                 {
                     m_Undos[i] = default(T);
                 }
+
                 m_new = 1;
                 m_old = 0;
             }
-- 
cgit v1.1