Changeset 443 for cafu/trunk

Timestamp:

12/15/11 15:38:09 (5 months ago)

Author:

Carsten

Message:

CaWE: In order to facilitate debugging, add a check for detecting accidental recursive re-enterings of the CommandHistoryT methods.

Location:

cafu/trunk/CaWE

Files:

• CommandHistory.cpp (modified) (4 diffs)
• CommandHistory.hpp (modified) (1 diff)

cafu/trunk/CaWE/CommandHistory.cpp

@@ -30 +30 @@
 
 
+namespace
+{
+    class RecursionCheckerT
+    {
+        public:
+
+        RecursionCheckerT(bool& IsActive) : m_IsActive(IsActive) { wxASSERT(!m_IsActive); m_IsActive=true; }
+        ~RecursionCheckerT() { m_IsActive=false; }
+
+
+        private:
+
+        bool& m_IsActive;
+    };
+}
+
+
 CommandHistoryT::CommandHistoryT()
     : m_CurrentIndex(-1),
+      m_Debug_IsActive(false),
       m_InvalidCommandID(0)
 {
@@ -81 +99 @@
     if (m_CurrentIndex<0) return;
     wxASSERT(m_CurrentIndex<(int)m_Commands.Size());
+    RecursionCheckerT RecCheck(m_Debug_IsActive);
 
     // Undo all commands from the invisible commands list and delete them.
@@ -112 +131 @@
     if (m_CurrentIndex+1>=int(m_Commands.Size())) return;
     wxASSERT(m_CurrentIndex<(int)m_Commands.Size()-1);
+    RecursionCheckerT RecCheck(m_Debug_IsActive);
 
     // Undo all commands from the invisible commands list and delete them.
@@ -141 +161 @@
 bool CommandHistoryT::SubmitCommand(CommandT* Command)
 {
+    RecursionCheckerT RecCheck(m_Debug_IsActive);
+
     if (!Command->IsDone() && !Command->Do())
     {

cafu/trunk/CaWE/CommandHistory.hpp

@@ -48 +48 @@
     ArrayT<CommandT*> m_Commands;
     ArrayT<CommandT*> m_InvisCommands;    ///< Stores all commands not visible in the history until a visible command is added to the history (then they are moved into the normal history).
-    int               m_CurrentIndex;     ///< The current index inside the commands array. -1 means no valid index.
+    int               m_CurrentIndex;     ///< The index of the last done command: all commands in <code>m_Commands[0 ... m_CurrentIndex]</code> are "done" (available for undo), any commands following them are "undone" (available for redo). If m_CurrentIndex is -1, there are no "done" commands at all.
+    bool              m_Debug_IsActive;   ///< In order to facilitate debugging, this member helps with detecting recursive calls to our functions. For example, when we call a commands CommandT::Undo() method, does it erroneously cause a recursive call back to SubmitCommand()?
 
     /// The command id returned when there is no current command (when the current index is -1).