Add a helper wxApp::GetValidTraits() method.
[wxWidgets.git] / src / common / cmdproc.cpp
index 104bebb06335a5be8f708fab359fee8cd1aff98d..5e8a253ccbbeea631ee1ebc20eebcab533c600f0 100644 (file)
@@ -6,7 +6,7 @@
 // Created:     05.11.00
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWidgets team
-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 // headers
 // ----------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "cmdproc.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
@@ -32,6 +28,7 @@
     #include "wx/intl.h"
     #include "wx/string.h"
     #include "wx/menu.h"
+    #include "wx/accel.h"
 #endif //WX_PRECOMP
 
 #include "wx/cmdproc.h"
@@ -53,10 +50,6 @@ wxCommand::wxCommand(bool canUndoIt, const wxString& name)
     m_commandName = name;
 }
 
-wxCommand::~wxCommand()
-{
-}
-
 // ----------------------------------------------------------------------------
 // Command processor
 // ----------------------------------------------------------------------------
@@ -65,13 +58,16 @@ wxCommandProcessor::wxCommandProcessor(int maxCommands)
 {
     m_maxNoCommands = maxCommands;
 #if wxUSE_MENUS
-    m_commandEditMenu = (wxMenu *) NULL;
+    m_commandEditMenu = NULL;
 #endif // wxUSE_MENUS
-    m_undoAccelerator = wxT("\tCtrl+Z");
-    m_redoAccelerator = wxT("\tCtrl+Y");
-#if !wxUSE_STL
-    m_currentCommand = NULL;
-#endif
+
+#if wxUSE_ACCEL
+    m_undoAccelerator = '\t' + wxAcceleratorEntry(wxACCEL_CTRL, 'Z').ToString();
+    m_redoAccelerator = '\t' + wxAcceleratorEntry(wxACCEL_CTRL, 'Y').ToString();
+#endif // wxUSE_ACCEL
+
+    m_lastSavedCommand =
+    m_currentCommand = wxList::compatibility_iterator();
 }
 
 wxCommandProcessor::~wxCommandProcessor()
@@ -91,36 +87,30 @@ bool wxCommandProcessor::UndoCommand(wxCommand& cmd)
 
 // Pass a command to the processor. The processor calls Do();
 // if successful, is appended to the command history unless
-// storeIt is FALSE.
+// storeIt is false.
 bool wxCommandProcessor::Submit(wxCommand *command, bool storeIt)
 {
-    wxCHECK_MSG( command, FALSE, _T("no command in wxCommandProcessor::Submit") );
+    wxCHECK_MSG( command, false, wxT("no command in wxCommandProcessor::Submit") );
 
     if ( !DoCommand(*command) )
     {
         // the user code expects the command to be deleted anyhow
         delete command;
 
-        return FALSE;
+        return false;
     }
 
     if ( storeIt )
         Store(command);
+    else
+        delete command;
 
-    return TRUE;
+    return true;
 }
 
 void wxCommandProcessor::Store(wxCommand *command)
 {
-    wxCHECK_RET( command, _T("no command in wxCommandProcessor::Store") );
-
-    if ( (int)m_commands.GetCount() == m_maxNoCommands )
-    {
-        wxList::compatibility_iterator firstNode = m_commands.GetFirst();
-        wxCommand *firstCommand = (wxCommand *)firstNode->GetData();
-        delete firstCommand;
-        m_commands.Erase(firstNode);
-    }
+    wxCHECK_RET( command, wxT("no command in wxCommandProcessor::Store") );
 
     // Correct a bug: we must chop off the current 'branch'
     // so that we're at the end of the command list.
@@ -132,12 +122,31 @@ void wxCommandProcessor::Store(wxCommand *command)
         while (node)
         {
             wxList::compatibility_iterator next = node->GetNext();
+
+            // Make sure m_lastSavedCommand won't point to freed memory
+            if ( m_lastSavedCommand && m_lastSavedCommand == node )
+                m_lastSavedCommand = wxList::compatibility_iterator();
+
             delete (wxCommand *)node->GetData();
             m_commands.Erase(node);
+
             node = next;
         }
     }
 
+    if ( (int)m_commands.GetCount() == m_maxNoCommands )
+    {
+        wxList::compatibility_iterator firstNode = m_commands.GetFirst();
+
+        // Make sure m_lastSavedCommand won't point to freed memory
+        if ( m_lastSavedCommand && m_lastSavedCommand == firstNode )
+            m_lastSavedCommand = wxList::compatibility_iterator();
+
+        wxCommand *firstCommand = (wxCommand *)firstNode->GetData();
+        delete firstCommand;
+        m_commands.Erase(firstNode);
+    }
+
     m_commands.Append(command);
     m_currentCommand = m_commands.GetLast();
     SetMenuStrings();
@@ -152,20 +161,20 @@ bool wxCommandProcessor::Undo()
         {
             m_currentCommand = m_currentCommand->GetPrevious();
             SetMenuStrings();
-            return TRUE;
+            return true;
         }
     }
 
-    return FALSE;
+    return false;
 }
 
 bool wxCommandProcessor::Redo()
 {
-    wxCommand *redoCommand = (wxCommand *) NULL;
+    wxCommand *redoCommand = NULL;
     wxList::compatibility_iterator redoNode
-#if !wxUSE_STL
+#if !wxUSE_STD_CONTAINERS
         = NULL          // just to avoid warnings
-#endif // !wxUSE_STL
+#endif // !wxUSE_STD_CONTAINERS
         ;
 
     if ( m_currentCommand )
@@ -193,10 +202,10 @@ bool wxCommandProcessor::Redo()
         {
             m_currentCommand = redoNode;
             SetMenuStrings();
-            return TRUE;
+            return true;
         }
     }
-    return FALSE;
+    return false;
 }
 
 bool wxCommandProcessor::CanUndo() const
@@ -209,15 +218,15 @@ bool wxCommandProcessor::CanUndo() const
 bool wxCommandProcessor::CanRedo() const
 {
     if (m_currentCommand && !m_currentCommand->GetNext())
-        return FALSE;
+        return false;
 
     if (m_currentCommand && m_currentCommand->GetNext())
-        return TRUE;
+        return true;
 
     if (!m_currentCommand && (m_commands.GetCount() > 0))
-        return TRUE;
+        return true;
 
-    return FALSE;
+    return false;
 }
 
 void wxCommandProcessor::Initialize()
@@ -233,7 +242,7 @@ void wxCommandProcessor::SetMenuStrings()
     {
         wxString undoLabel = GetUndoMenuLabel();
         wxString redoLabel = GetRedoMenuLabel();
-        
+
         m_commandEditMenu->SetLabel(wxID_UNDO, undoLabel);
         m_commandEditMenu->Enable(wxID_UNDO, CanUndo());
 
@@ -251,7 +260,7 @@ wxString wxCommandProcessor::GetUndoMenuLabel() const
     {
         wxCommand *command = (wxCommand *)m_currentCommand->GetData();
         wxString commandName(command->GetName());
-        if (commandName == wxT("")) commandName = _("Unnamed command");
+        if (commandName.empty()) commandName = _("Unnamed command");
         bool canUndo = command->CanUndo();
         if (canUndo)
             buf = wxString(_("&Undo ")) + commandName + m_undoAccelerator;
@@ -262,7 +271,7 @@ wxString wxCommandProcessor::GetUndoMenuLabel() const
     {
         buf = _("&Undo") + m_undoAccelerator;
     }
-    
+
     return buf;
 }
 
@@ -277,7 +286,7 @@ wxString wxCommandProcessor::GetRedoMenuLabel() const
         {
             wxCommand *redoCommand = (wxCommand *)m_currentCommand->GetNext()->GetData();
             wxString redoCommandName(redoCommand->GetName());
-            if (redoCommandName == wxT("")) redoCommandName = _("Unnamed command");
+            if (redoCommandName.empty()) redoCommandName = _("Unnamed command");
             buf = wxString(_("&Redo ")) + redoCommandName + m_redoAccelerator;
         }
         else
@@ -297,7 +306,7 @@ wxString wxCommandProcessor::GetRedoMenuLabel() const
             // we've undone to the start of the list, but can redo the first.
             wxCommand *redoCommand = (wxCommand *)m_commands.GetFirst()->GetData();
             wxString redoCommandName(redoCommand->GetName());
-            if (redoCommandName == wxT("")) redoCommandName = _("Unnamed command");
+            if (redoCommandName.empty()) redoCommandName = _("Unnamed command");
             buf = wxString(_("&Redo ")) + redoCommandName + m_redoAccelerator;
         }
     }
@@ -314,7 +323,33 @@ void wxCommandProcessor::ClearCommands()
         m_commands.Erase(node);
         node = m_commands.GetFirst();
     }
+
     m_currentCommand = wxList::compatibility_iterator();
+    m_lastSavedCommand = wxList::compatibility_iterator();
 }
 
+bool wxCommandProcessor::IsDirty() const
+{
+    if ( m_commands.empty() )
+    {
+        // If we have never been modified, we can't be dirty.
+        return false;
+    }
+
+    if ( !m_lastSavedCommand )
+    {
+        // If we have been modified but have never been saved, we're dirty.
+        return true;
+    }
+
+    if ( !m_currentCommand )
+    {
+        // This only happens if all commands were undone after saving the
+        // document: we're dirty then.
+        return true;
+    }
+
+    // Finally if both iterators are valid, we may just compare them.
+    return m_currentCommand != m_lastSavedCommand;
+}