]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/event.cpp
fixed wxSplitPath() bug and added tests for it
[wxWidgets.git] / src / common / event.cpp
index 831b257dcdb5c822895982f5c4ef8f423f37ff60..87eda81fdb0ab43f4b79f2295cd6924a26967241 100644 (file)
@@ -6,9 +6,17 @@
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:       wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
 #ifdef __GNUG__
     #pragma implementation "event.h"
 #endif
 
 #ifndef WX_PRECOMP
     #include "wx/defs.h"
-    #include "wx/control.h"
-    #include "wx/utils.h"
     #include "wx/app.h"
-    #include "wx/dc.h"
+    #include "wx/list.h"
+
+    #if wxUSE_GUI
+        #include "wx/control.h"
+        #include "wx/utils.h"
+        #include "wx/dc.h"
+    #endif // wxUSE_GUI
 #endif
 
 #include "wx/event.h"
-#include "wx/validate.h"
 
-#if !USE_SHARED_LIBRARY
-    IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
-    IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
+#if wxUSE_GUI
+    #include "wx/validate.h"
+#endif // wxUSE_GUI
+
+// ----------------------------------------------------------------------------
+// wxWin macros
+// ----------------------------------------------------------------------------
+
+IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
+IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
+IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
+
+#if wxUSE_GUI
     IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
-    IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxCommandEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)
     IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)
+    IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
+#endif // wxUSE_GUI
+
+const wxEventTable *wxEvtHandler::GetEventTable() const
+    { return &wxEvtHandler::sm_eventTable; }
+
+const wxEventTable wxEvtHandler::sm_eventTable =
+    { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
 
-    const wxEventTable *wxEvtHandler::GetEventTable() const
-        { return &wxEvtHandler::sm_eventTable; }
+const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
+    { { 0, 0, 0, (wxObjectEventFunction) NULL, (wxObject*) NULL } };
 
-    const wxEventTable wxEvtHandler::sm_eventTable =
-        { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
 
-    const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
-        { { 0, 0, 0, (wxObjectEventFunction) NULL, (wxObject*) NULL } };
+// ----------------------------------------------------------------------------
+// global variables
+// ----------------------------------------------------------------------------
 
-#endif // !USE_SHARED_LIBRARY
+// To put pending event handlers
+wxList *wxPendingEvents = (wxList *)NULL;
 
 #if wxUSE_THREADS
-/* To put pending event handlers */
-extern wxList *wxPendingEvents;
-extern wxCriticalSection *wxPendingEventsLocker;
+    // protects wxPendingEvents list
+    wxCriticalSection *wxPendingEventsLocker = (wxCriticalSection *)NULL;
 #endif
 
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxEvent
+// ----------------------------------------------------------------------------
+
 /*
  * General wxWindows events, covering
  * all interesting things that might happen (button clicking, resizing,
@@ -102,7 +137,7 @@ wxEvent::wxEvent(int theId)
 
 void wxEvent::CopyObject(wxObject& object_dest) const
 {
-    wxEvent *obj = (wxEvent *)&object_dest; 
+    wxEvent *obj = (wxEvent *)&object_dest;
     wxObject::CopyObject(object_dest);
 
     obj->m_eventType = m_eventType;
@@ -114,6 +149,8 @@ void wxEvent::CopyObject(wxObject& object_dest) const
     obj->m_isCommandEvent = m_isCommandEvent;
 }
 
+#if wxUSE_GUI
+
 /*
  * Command events
  *
@@ -133,14 +170,28 @@ wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
 
 void wxCommandEvent::CopyObject(wxObject& obj_d) const
 {
-    wxCommandEvent *obj = (wxCommandEvent *)&obj_d; 
+    wxCommandEvent *obj = (wxCommandEvent *)&obj_d;
 
     wxEvent::CopyObject(obj_d);
 
-    obj->m_clientData   = m_clientData;
-    obj->m_clientObject = m_clientObject;
-    obj->m_extraLong    = m_extraLong;
-    obj->m_commandInt   = m_commandInt;
+    obj->m_clientData    = m_clientData;
+    obj->m_clientObject  = m_clientObject;
+    obj->m_extraLong     = m_extraLong;
+    obj->m_commandInt    = m_commandInt;
+    obj->m_commandString = m_commandString;
+}
+
+/*
+ * Notify events
+ */
+
+void wxNotifyEvent::CopyObject(wxObject& obj_d) const
+{
+    wxNotifyEvent *obj = (wxNotifyEvent *)&obj_d;
+
+    wxEvent::CopyObject(obj_d);
+
+    if (!m_bAllow) obj->Veto();
 }
 
 /*
@@ -172,7 +223,7 @@ wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
 
 void wxScrollWinEvent::CopyObject(wxObject& obj_d) const
 {
-    wxScrollWinEvent *obj = (wxScrollWinEvent*)&obj_d; 
+    wxScrollWinEvent *obj = (wxScrollWinEvent*)&obj_d;
 
     wxEvent::CopyObject(obj_d);
 
@@ -231,7 +282,7 @@ bool wxMouseEvent::ButtonDClick(int but) const
         case 3:
             return RightDClick();
         default:
-            wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonDClick"));
+            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
     }
 
     return FALSE;
@@ -252,7 +303,7 @@ bool wxMouseEvent::ButtonDown(int but) const
         case 3:
             return RightDown();
         default:
-            wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonDown"));
+            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
     }
 
     return FALSE;
@@ -272,7 +323,7 @@ bool wxMouseEvent::ButtonUp(int but) const
         case 3:
             return RightUp();
         default:
-            wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonUp"));
+            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
     }
 
     return FALSE;
@@ -283,7 +334,7 @@ bool wxMouseEvent::Button(int but) const
 {
     switch (but) {
         case -1:
-            return (ButtonUp(-1) || ButtonDown(-1) || ButtonDClick(-1)) ;
+            return (ButtonUp(-1) || ButtonDown(-1) || ButtonDClick(-1));
         case 1:
             return (LeftDown() || LeftUp() || LeftDClick());
         case 2:
@@ -291,7 +342,7 @@ bool wxMouseEvent::Button(int but) const
         case 3:
             return (RightDown() || RightUp() || RightDClick());
         default:
-            wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::Button"));
+            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
     }
 
     return FALSE;
@@ -309,7 +360,7 @@ bool wxMouseEvent::ButtonIsDown(int but) const
         case 3:
             return RightIsDown();
         default:
-            wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonIsDown"));
+            wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
     }
 
     return FALSE;
@@ -344,6 +395,10 @@ void wxKeyEvent::CopyObject(wxObject& obj_d) const
     wxKeyEvent *obj = (wxKeyEvent *)&obj_d;
     wxEvent::CopyObject(obj_d);
 
+    obj->m_x = m_x;
+    obj->m_y = m_y;
+    obj->m_keyCode = m_keyCode;
+    
     obj->m_shiftDown   = m_shiftDown;
     obj->m_controlDown = m_controlDown;
     obj->m_metaDown    = m_metaDown;
@@ -408,7 +463,7 @@ void wxCloseEvent::CopyObject(wxObject& obj_d) const
 #endif
     obj->m_canVeto = m_canVeto;
 }
+
 void wxShowEvent::CopyObject(wxObject& obj_d) const
 {
     wxShowEvent *obj = (wxShowEvent *)&obj_d;
@@ -427,7 +482,7 @@ void wxJoystickEvent::CopyObject(wxObject& obj_d) const
     obj->m_buttonChange = m_buttonChange;
     obj->m_buttonState = m_buttonState;
     obj->m_joyStick = m_joyStick;
-} 
+}
 
 void wxDropFilesEvent::CopyObject(wxObject& obj_d) const
 {
@@ -437,15 +492,7 @@ void wxDropFilesEvent::CopyObject(wxObject& obj_d) const
     obj->m_noFiles = m_noFiles;
     obj->m_pos = m_pos;
     // TODO: Problem with obj->m_files. It should be deallocated by the
-    // destructor of the event. 
-}
-
-void wxIdleEvent::CopyObject(wxObject& obj_d) const
-{
-    wxIdleEvent *obj = (wxIdleEvent *)&obj_d;
-    wxEvent::CopyObject(obj_d);
-
-    obj->m_requestMore = m_requestMore;
+    // destructor of the event.
 }
 
 void wxUpdateUIEvent::CopyObject(wxObject &obj_d) const
@@ -478,17 +525,27 @@ void wxQueryNewPaletteEvent::CopyObject(wxObject& obj_d) const
 }
 
 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
-                   : wxEvent(wxEVT_CREATE)
 {
+    SetEventType(wxEVT_CREATE);
     SetEventObject(win);
 }
 
 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
-                    : wxEvent(wxEVT_DESTROY)
 {
+    SetEventType(wxEVT_DESTROY);
     SetEventObject(win);
 }
 
+#endif // wxUSE_GUI
+
+void wxIdleEvent::CopyObject(wxObject& obj_d) const
+{
+    wxIdleEvent *obj = (wxIdleEvent *)&obj_d;
+    wxEvent::CopyObject(obj_d);
+
+    obj->m_requestMore = m_requestMore;
+}
+
 /*
  * Event handler
  */
@@ -500,10 +557,12 @@ wxEvtHandler::wxEvtHandler()
     m_enabled = TRUE;
     m_dynamicEvents = (wxList *) NULL;
     m_isWindow = FALSE;
+    m_pendingEvents = (wxList *) NULL;
 #if wxUSE_THREADS
-    m_eventsLocker = new wxCriticalSection();
+#  if !defined(__VISAGECPP__)
+    m_eventsLocker = new wxCriticalSection;
+#  endif
 #endif
-    m_pendingEvents = (wxList *) NULL;
 }
 
 wxEvtHandler::~wxEvtHandler()
@@ -528,62 +587,107 @@ wxEvtHandler::~wxEvtHandler()
         delete m_dynamicEvents;
     };
 
-#if wxUSE_THREADS
-    if (m_pendingEvents)
-      delete m_pendingEvents;
+    delete m_pendingEvents;
 
+#if wxUSE_THREADS
+#  if !defined(__VISAGECPP__)
     delete m_eventsLocker;
+#  endif
 #endif
 }
 
 #if wxUSE_THREADS
 
-#ifdef __WXGTK__
-extern bool g_isIdle;
-extern void wxapp_install_idle_handler();
-#endif
-
 bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
 {
-    wxEvent *event_main;
-    wxCriticalSectionLocker locker(*m_eventsLocker);
-
     // check that we are really in a child thread
-    wxASSERT( !wxThread::IsMain() );
+    wxASSERT_MSG( !wxThread::IsMain(),
+                  wxT("use ProcessEvent() in main thread") );
 
-    if (m_pendingEvents == NULL)
-      m_pendingEvents = new wxList();
+    AddPendingEvent(event);
 
-    event_main = (wxEvent *)event.Clone();
+    return TRUE;
+}
 
-    m_pendingEvents->Append(event_main);
+#endif // wxUSE_THREADS
 
-    wxPendingEventsLocker->Enter();
-    wxPendingEvents->Append(this);
-    wxPendingEventsLocker->Leave();
+void wxEvtHandler::AddPendingEvent(wxEvent& event)
+{
+    // 1) Add event to list of pending events of this event handler
 
-#ifdef __WXGTK__
-    if (g_isIdle) 
-        wxapp_install_idle_handler();
+#if defined(__VISAGECPP__)
+    wxENTER_CRIT_SECT( m_eventsLocker);
+#else
+    wxENTER_CRIT_SECT( *m_eventsLocker);
 #endif
 
-    return TRUE;
+    if ( !m_pendingEvents )
+      m_pendingEvents = new wxList;
+
+    wxEvent *event2 = (wxEvent *)event.Clone();
+
+    m_pendingEvents->Append(event2);
+
+#if defined(__VISAGECPP__)
+    wxLEAVE_CRIT_SECT( m_eventsLocker);
+#else
+    wxLEAVE_CRIT_SECT( *m_eventsLocker);
+#endif
+
+    // 2) Add this event handler to list of event handlers that
+    //    have pending events.
+
+    wxENTER_CRIT_SECT(*wxPendingEventsLocker);
+
+    if ( !wxPendingEvents )
+        wxPendingEvents = new wxList;
+    wxPendingEvents->Append(this);
+
+    wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
+    
+    // 3) Inform the system that new pending events are somwehere,
+    //    and that these should be processed in idle time.
+    wxWakeUpIdle();
 }
 
 void wxEvtHandler::ProcessPendingEvents()
 {
-    wxCriticalSectionLocker locker(*m_eventsLocker);
+#if defined(__VISAGECPP__)
+    wxENTER_CRIT_SECT( m_eventsLocker);
+#else
+    wxENTER_CRIT_SECT( *m_eventsLocker);
+#endif
+
     wxNode *node = m_pendingEvents->First();
-    wxEvent *event;
+    while ( node )
+    {
+        wxEvent *event = (wxEvent *)node->Data();
+        delete node;
 
-    while (node != NULL) {
-      event = (wxEvent *)node->Data();
-      ProcessEvent(*event);
-      delete node;
-      node = m_pendingEvents->First();
+        // In ProcessEvent, new events might get added and
+           // we can safely leave the crtical section here.
+#if defined(__VISAGECPP__)
+        wxLEAVE_CRIT_SECT( m_eventsLocker);
+#else
+        wxLEAVE_CRIT_SECT( *m_eventsLocker);
+#endif
+        ProcessEvent(*event);
+        delete event;
+#if defined(__VISAGECPP__)
+        wxENTER_CRIT_SECT( m_eventsLocker);
+#else
+        wxENTER_CRIT_SECT( *m_eventsLocker);
+#endif
+
+        node = m_pendingEvents->First();
     }
-}
+
+#if defined(__VISAGECPP__)
+    wxLEAVE_CRIT_SECT( m_eventsLocker);
+#else
+    wxLEAVE_CRIT_SECT( *m_eventsLocker);
 #endif
+}
 
 /*
  * Event table stuff
@@ -591,27 +695,35 @@ void wxEvtHandler::ProcessPendingEvents()
 
 bool wxEvtHandler::ProcessEvent(wxEvent& event)
 {
-    /* check that our flag corresponds to reality */
+#if wxUSE_GUI
+    // check that our flag corresponds to reality
     wxASSERT( m_isWindow == IsKindOf(CLASSINFO(wxWindow)) );
+#endif // wxUSE_GUI
 
-    /* An event handler can be enabled or disabled */
+    // An event handler can be enabled or disabled
     if ( GetEvtHandlerEnabled() )
     {
-#if wxUSE_THREADS
-       /* Check whether we are in a child thread. */
-        if (!wxThread::IsMain())
+    
+#if 0
+/*
+        What is this? When using GUI threads, a non main
+        threads can send an event and process it itself.
+        This breaks GTK's GUI threads, so please explain.
+*/
+
+        // Check whether we are in a child thread.
+        if ( !wxThread::IsMain() )
           return ProcessThreadEvent(event);
 #endif
-        /* Handle per-instance dynamic event tables first */
 
+        // Handle per-instance dynamic event tables first
         if ( m_dynamicEvents && SearchDynamicEventTable(event) )
             return TRUE;
 
-        /* Then static per-class event tables */
-
+        // Then static per-class event tables
         const wxEventTable *table = GetEventTable();
 
-#if wxUSE_VALIDATORS
+#if wxUSE_GUI && wxUSE_VALIDATORS
         // Try the associated validator first, if this is a window.
         // Problem: if the event handler of the window has been replaced,
         // this wxEvtHandler may no longer be a window.
@@ -653,6 +765,7 @@ bool wxEvtHandler::ProcessEvent(wxEvent& event)
             return TRUE;
     }
 
+#if wxUSE_GUI
     // Carry on up the parent-child hierarchy,
     // but only if event is a command event: it wouldn't
     // make sense for a parent to receive a child's size event, for example
@@ -663,6 +776,7 @@ bool wxEvtHandler::ProcessEvent(wxEvent& event)
         if (parent && !parent->IsBeingDeleted())
             return parent->GetEventHandler()->ProcessEvent(event);
     }
+#endif // wxUSE_GUI
 
     // Last try - application object.
     if ( wxTheApp && (this != wxTheApp) )
@@ -682,37 +796,48 @@ bool wxEvtHandler::ProcessEvent(wxEvent& event)
 
 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
 {
-    int i = 0;
-    int commandId = event.GetId();
+    wxEventType eventType = event.GetEventType();
+    int eventId = event.GetId();
 
-    // BC++ doesn't like while (table.entries[i].m_fn)
-
-#ifdef __SC__
-    while (table.entries[i].m_fn != 0)
+    // BC++ doesn't like testing for m_fn without != 0
+    for ( int i = 0; table.entries[i].m_fn != 0; i++ )
+    {
+        // the line using reference exposes a bug in gcc: although it _seems_
+        // to work, it leads to weird crashes later on during program
+        // execution
+#ifdef __GNUG__
+        wxEventTableEntry entry = table.entries[i];
 #else
-    while (table.entries[i].m_fn != 0L)
+        const wxEventTableEntry& entry = table.entries[i];
 #endif
-    {
-        if ((event.GetEventType() == table.entries[i].m_eventType) &&
-                (table.entries[i].m_id == -1 || // Match, if event spec says any id will do (id == -1)
-                 (table.entries[i].m_lastId == -1 && commandId == table.entries[i].m_id) ||
-                 (table.entries[i].m_lastId != -1 &&
-                  (commandId >= table.entries[i].m_id && commandId <= table.entries[i].m_lastId))))
+
+        // match only if the event type is the same and the id is either -1 in
+        // the event table (meaning "any") or the event id matches the id
+        // specified in the event table either exactly or by falling into
+        // range between first and last
+        if ( eventType == entry.m_eventType )
         {
-            event.Skip(FALSE);
-            event.m_callbackUserData = table.entries[i].m_callbackUserData;
+            int tableId1 = entry.m_id,
+                tableId2 = entry.m_lastId;
 
-            (this->*((wxEventFunction) (table.entries[i].m_fn)))(event);
+            if ( (tableId1 == -1) ||
+                 (tableId2 == -1 && eventId == tableId1) ||
+                 (tableId2 != -1 &&
+                    (eventId >= tableId1 && eventId <= tableId2)) )
+            {
+                event.Skip(FALSE);
+                event.m_callbackUserData = entry.m_callbackUserData;
 
-            if ( event.GetSkipped() )
-                return FALSE;
-            else
-                return TRUE;
+                (this->*((wxEventFunction) (entry.m_fn)))(event);
+
+                return !event.GetSkipped();
+            }
         }
-        i++;
     }
+
     return FALSE;
 }
+
 void wxEvtHandler::Connect( int id, int lastId,
                             wxEventType eventType,
                             wxObjectEventFunction func,
@@ -731,10 +856,37 @@ void wxEvtHandler::Connect( int id, int lastId,
     m_dynamicEvents->Append( (wxObject*) entry );
 }
 
+bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType,
+                  wxObjectEventFunction func,
+                  wxObject *userData )
+{
+    if (!m_dynamicEvents)
+        return FALSE;
+
+    wxNode *node = m_dynamicEvents->First();
+    while (node)
+    {
+        wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
+        if ((entry->m_id == id) &&
+            ((entry->m_lastId == lastId) || (lastId == -1)) &&
+            ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
+            ((entry->m_fn == func) || (func == (wxObjectEventFunction)NULL)) &&
+            ((entry->m_callbackUserData == userData) || (userData == (wxObject*)NULL)))
+        {
+            if (entry->m_callbackUserData) delete entry->m_callbackUserData;
+            m_dynamicEvents->DeleteNode( node );
+            delete entry;
+            return TRUE;
+        }
+        node = node->Next();
+    }
+    return FALSE;
+}
+
 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
 {
     wxCHECK_MSG( m_dynamicEvents, FALSE,
-                 _T("caller should check that we have dynamic events") );
+                 wxT("caller should check that we have dynamic events") );
 
     int commandId = event.GetId();
 
@@ -778,6 +930,8 @@ bool wxEvtHandler::OnClose()
 }
 #endif // WXWIN_COMPATIBILITY
 
+#if wxUSE_GUI
+
 // Find a window with the focus, that is also a descendant of the given window.
 // This is used to determine the window to initially send commands to.
 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
@@ -801,3 +955,4 @@ wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
     return focusWin;
 }
 
+#endif // wxUSE_GUI