/////////////////////////////////////////////////////////////////////////////
-// Name: event.cpp
+// Name: src/common/event.cpp
// Purpose: Event classes
// Author: Julian Smart
// Modified by:
// headers
// ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && !defined(__EMX__)
-// Some older compilers (such as EMX) cannot handle
-// #pragma interface/implementation correctly, iff
-// #pragma implementation is used in _two_ translation
-// units (as created by e.g. event.cpp compiled for
-// libwx_base and event.cpp compiled for libwx_gui_core).
-// So we must not use those pragmas for those compilers in
-// such files.
- #pragma implementation "event.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#pragma hdrstop
#endif
+#include "wx/event.h"
+#include "wx/evtloop.h"
+
#ifndef WX_PRECOMP
- #include "wx/defs.h"
- #include "wx/app.h"
#include "wx/list.h"
+ #include "wx/app.h"
+ #include "wx/utils.h"
+ #include "wx/stopwatch.h"
+ #include "wx/module.h"
#if wxUSE_GUI
+ #include "wx/window.h"
#include "wx/control.h"
- #include "wx/utils.h"
#include "wx/dc.h"
#include "wx/textctrl.h"
+ #include "wx/validate.h"
#endif // wxUSE_GUI
#endif
-#include "wx/event.h"
-#include "wx/module.h"
+#include "wx/thread.h"
-#if wxUSE_GUI
- #include "wx/validate.h"
-#if wxUSE_STOPWATCH
- #include "wx/stopwatch.h"
-#endif
-#endif // wxUSE_GUI
+#if wxUSE_BASE
+ #include "wx/ptr_scpd.h"
+
+ wxDECLARE_SCOPED_PTR(wxEvent, wxEventPtr)
+ wxDEFINE_SCOPED_PTR(wxEvent, wxEventPtr)
+#endif // wxUSE_BASE
// ----------------------------------------------------------------------------
// wxWin macros
#if wxUSE_BASE
IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
+ IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
#endif // wxUSE_BASE
#if wxUSE_GUI
- IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)
IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)
+ IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent, wxEvent)
+ IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent, wxCommandEvent)
#endif // wxUSE_GUI
#if wxUSE_BASE
{ DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL, 0, 0, (wxObjectEventFunction)NULL, NULL) };
-#ifdef __WXDEBUG__
-// Clear up event hash table contents or we can get problems
-// when C++ is cleaning up the static object
+// wxUSE_MEMORY_TRACING considers memory freed from the static objects dtors
+// leaked, so we need to manually clean up all event tables before checking for
+// the memory leaks when using it, however this breaks re-initializing the
+// library (i.e. repeated calls to wxInitialize/wxUninitialize) because the
+// event tables won't be rebuilt the next time, so disable this by default
+#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
+
class wxEventTableEntryModule: public wxModule
{
-DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)
public:
- wxEventTableEntryModule() {}
- bool OnInit() { return true; }
- void OnExit()
- {
- wxEventHashTable::ClearAll();
- }
+ wxEventTableEntryModule() { }
+ virtual bool OnInit() { return true; }
+ virtual void OnExit() { wxEventHashTable::ClearAll(); }
+
+ DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)
};
+
IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)
-#endif
+
+#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
// ----------------------------------------------------------------------------
// global variables
// ----------------------------------------------------------------------------
-// To put pending event handlers
-wxList *wxPendingEvents = (wxList *)NULL;
+// List containing event handlers with pending events (each handler can occur
+// at most once here)
+wxList *wxHandlersWithPendingEvents = NULL;
#if wxUSE_THREADS
- // protects wxPendingEvents list
- wxCriticalSection *wxPendingEventsLocker = (wxCriticalSection *)NULL;
+ // protects wxHandlersWithPendingEvents list
+ wxCriticalSection *wxHandlersWithPendingEventsLocker = NULL;
#endif
-#if !WXWIN_COMPATIBILITY_EVENT_TYPES
-
// common event types are defined here, other event types are defined by the
// components which use them
DEFINE_EVENT_TYPE(wxEVT_NULL)
DEFINE_EVENT_TYPE(wxEVT_IDLE)
DEFINE_EVENT_TYPE(wxEVT_SOCKET)
-
-#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
+DEFINE_EVENT_TYPE(wxEVT_TIMER)
#endif // wxUSE_BASE
#if wxUSE_GUI
-#if !WXWIN_COMPATIBILITY_EVENT_TYPES
-
DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED)
DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED)
DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED)
DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED)
DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER)
DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED)
-
-// Sockets and timers send events, too
-DEFINE_EVENT_TYPE(wxEVT_TIMER)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED)
// Mouse event types
DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN)
DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS)
DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS)
DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL)
+DEFINE_EVENT_TYPE(wxEVT_AUX1_DOWN)
+DEFINE_EVENT_TYPE(wxEVT_AUX1_UP)
+DEFINE_EVENT_TYPE(wxEVT_AUX1_DCLICK)
+DEFINE_EVENT_TYPE(wxEVT_AUX2_DOWN)
+DEFINE_EVENT_TYPE(wxEVT_AUX2_UP)
+DEFINE_EVENT_TYPE(wxEVT_AUX2_DCLICK)
// Non-client mouse events
DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN)
DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN)
DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK)
DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE)
-DEFINE_EVENT_TYPE(wxEVT_SCROLL_ENDSCROLL)
+DEFINE_EVENT_TYPE(wxEVT_SCROLL_CHANGED)
// Scroll events from wxWindow
DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP)
DEFINE_EVENT_TYPE(wxEVT_SIZING)
DEFINE_EVENT_TYPE(wxEVT_MOVE)
DEFINE_EVENT_TYPE(wxEVT_MOVING)
+DEFINE_EVENT_TYPE(wxEVT_MOVE_START)
+DEFINE_EVENT_TYPE(wxEVT_MOVE_END)
DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW)
DEFINE_EVENT_TYPE(wxEVT_END_SESSION)
DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION)
+DEFINE_EVENT_TYPE(wxEVT_HIBERNATE)
DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP)
-DEFINE_EVENT_TYPE(wxEVT_POWER)
DEFINE_EVENT_TYPE(wxEVT_ACTIVATE)
DEFINE_EVENT_TYPE(wxEVT_CREATE)
DEFINE_EVENT_TYPE(wxEVT_DESTROY)
DEFINE_EVENT_TYPE(wxEVT_ICONIZE)
DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE)
DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED)
+DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST)
DEFINE_EVENT_TYPE(wxEVT_PAINT)
DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND)
DEFINE_EVENT_TYPE(wxEVT_NC_PAINT)
DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG)
DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI)
+// Clipboard events
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE)
+
// Generic command events
// Note: a click is a higher-level event than button down/up
DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK)
DEFINE_EVENT_TYPE(wxEVT_HELP)
DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP)
-#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
-
#endif // wxUSE_GUI
#if wxUSE_BASE
+wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;
+
// ============================================================================
// implementation
// ============================================================================
m_propagationLevel = wxEVENT_PROPAGATE_NONE;
}
-wxEvent::wxEvent(const wxEvent &src)
- : wxObject()
+wxEvent::wxEvent(const wxEvent& src)
+ : wxObject(src)
, m_eventObject(src.m_eventObject)
, m_eventType(src.m_eventType)
, m_timeStamp(src.m_timeStamp)
{
}
+wxEvent& wxEvent::operator=(const wxEvent& src)
+{
+ wxObject::operator=(src);
+
+ m_eventObject = src.m_eventObject;
+ m_eventType = src.m_eventType;
+ m_timeStamp = src.m_timeStamp;
+ m_id = src.m_id;
+ m_callbackUserData = src.m_callbackUserData;
+ m_propagationLevel = src.m_propagationLevel;
+ m_skipped = src.m_skipped;
+ m_isCommandEvent = src.m_isCommandEvent;
+
+ return *this;
+}
+
#endif // wxUSE_BASE
#if wxUSE_GUI
wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
: wxEvent(theId, commandType)
-#if WXWIN_COMPATIBILITY_2_4
- , m_commandString(this)
-#endif
{
m_clientData = (char *) NULL;
m_clientObject = (wxClientData *) NULL;
wxString wxCommandEvent::GetString() const
{
- if(m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
+ if (m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
+ {
return m_cmdString;
+ }
else
{
#if wxUSE_TEXTCTRL
wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);
- if(txt)
+ if ( txt )
return txt->GetValue();
else
#endif // wxUSE_TEXTCTRL
#endif
}
-/*
- * Idle events
- */
-
-wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;
-
-// Can we send an idle event?
-bool wxIdleEvent::CanSend(wxWindow* win)
-{
- // Don't update if we've switched global updating off
- // and this window doesn't support updates.
- if (win &&
- (GetMode() == wxIDLE_PROCESS_SPECIFIED &&
- ((win->GetExtraStyle() & wxWS_EX_PROCESS_IDLE) == 0)))
- return false;
-
- return true;
-}
-
/*
* Scroll events
*/
wxMouseEvent::wxMouseEvent(wxEventType commandType)
{
m_eventType = commandType;
- m_metaDown = false;
- m_altDown = false;
- m_controlDown = false;
- m_shiftDown = false;
- m_leftDown = false;
- m_rightDown = false;
- m_middleDown = false;
+
m_x = 0;
m_y = 0;
+
+ m_leftDown = false;
+ m_middleDown = false;
+ m_rightDown = false;
+ m_aux1Down = false;
+ m_aux2Down = false;
+
+ m_clickCount = -1;
+
m_wheelRotation = 0;
m_wheelDelta = 0;
m_linesPerAction = 0;
+ m_wheelAxis = 0;
}
void wxMouseEvent::Assign(const wxMouseEvent& event)
{
- m_eventType = event.m_eventType;
+ wxEvent::operator=(event);
+
+ // Borland C++ 5.82 doesn't compile an explicit call to an implicitly
+ // defined operator=() so need to do it this way:
+ *static_cast<wxMouseState *>(this) = event;
m_x = event.m_x;
m_y = event.m_y;
m_leftDown = event.m_leftDown;
m_middleDown = event.m_middleDown;
m_rightDown = event.m_rightDown;
-
- m_controlDown = event.m_controlDown;
- m_shiftDown = event.m_shiftDown;
- m_altDown = event.m_altDown;
- m_metaDown = event.m_metaDown;
+ m_aux1Down = event.m_aux1Down;
+ m_aux2Down = event.m_aux2Down;
m_wheelRotation = event.m_wheelRotation;
m_wheelDelta = event.m_wheelDelta;
m_linesPerAction = event.m_linesPerAction;
+ m_wheelAxis = event.m_wheelAxis;
}
// return true if was a button dclick event
// fall through
case wxMOUSE_BTN_ANY:
- return (LeftDClick() || MiddleDClick() || RightDClick());
+ return (LeftDClick() || MiddleDClick() || RightDClick() ||
+ Aux1DClick() || Aux2DClick());
case wxMOUSE_BTN_LEFT:
return LeftDClick();
case wxMOUSE_BTN_RIGHT:
return RightDClick();
+
+ case wxMOUSE_BTN_AUX1:
+ return Aux1DClick();
+
+ case wxMOUSE_BTN_AUX2:
+ return Aux2DClick();
}
}
// fall through
case wxMOUSE_BTN_ANY:
- return (LeftDown() || MiddleDown() || RightDown());
+ return (LeftDown() || MiddleDown() || RightDown() ||
+ Aux1Down() || Aux2Down());
case wxMOUSE_BTN_LEFT:
return LeftDown();
case wxMOUSE_BTN_RIGHT:
return RightDown();
+
+ case wxMOUSE_BTN_AUX1:
+ return Aux1Down();
+
+ case wxMOUSE_BTN_AUX2:
+ return Aux2Down();
}
}
// fall through
case wxMOUSE_BTN_ANY:
- return (LeftUp() || MiddleUp() || RightUp());
+ return (LeftUp() || MiddleUp() || RightUp() ||
+ Aux1Up() || Aux2Up());
case wxMOUSE_BTN_LEFT:
return LeftUp();
case wxMOUSE_BTN_RIGHT:
return RightUp();
+
+ case wxMOUSE_BTN_AUX1:
+ return Aux1Up();
+
+ case wxMOUSE_BTN_AUX2:
+ return Aux2Up();
}
}
case wxMOUSE_BTN_RIGHT:
return RightDown() || RightUp() || RightDClick();
+
+ case wxMOUSE_BTN_AUX1:
+ return Aux1Down() || Aux1Up() || Aux1DClick();
+
+ case wxMOUSE_BTN_AUX2:
+ return Aux2Down() || Aux2Up() || Aux2DClick();
}
}
// fall through
case wxMOUSE_BTN_ANY:
- return LeftIsDown() || MiddleIsDown() || RightIsDown();
+ return LeftIsDown() || MiddleIsDown() || RightIsDown() || Aux1Down() || Aux2Down();
case wxMOUSE_BTN_LEFT:
return LeftIsDown();
case wxMOUSE_BTN_RIGHT:
return RightIsDown();
+
+ case wxMOUSE_BTN_AUX1:
+ return Aux1IsDown();
+
+ case wxMOUSE_BTN_AUX2:
+ return Aux2IsDown();
}
}
int wxMouseEvent::GetButton() const
{
- for ( int i = 1; i <= 3; i++ )
+ for ( int i = 1; i < wxMOUSE_BTN_MAX; i++ )
{
if ( Button(i) )
{
wxKeyEvent::wxKeyEvent(wxEventType type)
{
m_eventType = type;
- m_shiftDown = false;
- m_controlDown = false;
- m_metaDown = false;
- m_altDown = false;
m_keyCode = 0;
m_scanCode = 0;
#if wxUSE_UNICODE
}
wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
- : wxEvent(evt)
+ : wxEvent(evt),
+ wxKeyboardState(evt)
{
m_x = evt.m_x;
m_y = evt.m_y;
m_keyCode = evt.m_keyCode;
- m_controlDown = evt.m_controlDown;
- m_shiftDown = evt.m_shiftDown;
- m_altDown = evt.m_altDown;
- m_metaDown = evt.m_metaDown;
m_scanCode = evt.m_scanCode;
m_rawCode = evt.m_rawCode;
m_rawFlags = evt.m_rawFlags;
#endif
}
-long wxKeyEvent::KeyCode() const
-{
- return m_keyCode;
-}
-
wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
{
SetEventType(wxEVT_CREATE);
SetEventObject(win);
}
+// ----------------------------------------------------------------------------
+// wxHelpEvent
+// ----------------------------------------------------------------------------
+
+/* static */
+wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)
+{
+ if ( origin == Origin_Unknown )
+ {
+ // assume that the event comes from the help button if it's not from
+ // keyboard and that pressing F1 always results in the help event
+ origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton;
+ }
+
+ return origin;
+}
+
#endif // wxUSE_GUI
void wxEventHashTable::Clear()
{
- size_t i;
- for(i = 0; i < m_size; i++)
+ for ( size_t i = 0; i < m_size; i++ )
{
EventTypeTablePointer eTTnode = m_eventTypeTable[i];
- if (eTTnode)
- {
- delete eTTnode;
- }
+ delete eTTnode;
}
- // Necessary in order to not invoke the
- // overloaded delete operator when statics are cleaned up
- if (m_eventTypeTable)
- delete[] m_eventTypeTable;
-
+ delete[] m_eventTypeTable;
m_eventTypeTable = NULL;
+
m_size = 0;
}
+#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
+
// Clear all tables
void wxEventHashTable::ClearAll()
{
}
}
+#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
+
bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
{
if (m_rebuildHash)
delete[] oldEventTypeTable;
}
-
// ----------------------------------------------------------------------------
// wxEvtHandler
// ----------------------------------------------------------------------------
m_enabled = true;
m_dynamicEvents = (wxList *) NULL;
m_pendingEvents = (wxList *) NULL;
-#if wxUSE_THREADS
-# if !defined(__VISAGECPP__)
- m_eventsLocker = new wxCriticalSection;
-# endif
-#endif
+
// no client data (yet)
m_clientData = NULL;
m_clientDataType = wxClientData_None;
if (m_dynamicEvents)
{
- wxList::iterator it = m_dynamicEvents->begin(),
- en = m_dynamicEvents->end();
- for (;it != en; ++it)
+ for ( wxList::iterator it = m_dynamicEvents->begin(),
+ end = m_dynamicEvents->end();
+ it != end;
+ ++it )
{
-#if WXWIN_COMPATIBILITY_EVENT_TYPES
- wxEventTableEntry *entry = (wxEventTableEntry*)*it;
-#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
-#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
+
+ // Remove ourselves from sink destructor notifications
+ // (this has usually been been done, in wxTrackable destructor)
+ wxEvtHandler *eventSink = entry->m_eventSink;
+ if ( eventSink )
+ {
+ wxEventConnectionRef * const
+ evtConnRef = FindRefInTrackerList(eventSink);
+ if ( evtConnRef )
+ {
+ eventSink->RemoveNode(evtConnRef);
+ delete evtConnRef;
+ }
+ }
if (entry->m_callbackUserData)
delete entry->m_callbackUserData;
delete m_dynamicEvents;
};
+ if (m_pendingEvents)
+ m_pendingEvents->DeleteContents(true);
delete m_pendingEvents;
+ // Remove us from wxHandlersWithPendingEvents if necessary.
+ if ( wxHandlersWithPendingEvents )
+ {
#if wxUSE_THREADS
-# if !defined(__VISAGECPP__)
- delete m_eventsLocker;
-# endif
-
- // Remove us from wxPendingEvents if necessary.
- if(wxPendingEventsLocker)
- wxENTER_CRIT_SECT(*wxPendingEventsLocker);
- if ( wxPendingEvents ) {
- wxPendingEvents->DeleteObject(this);
- }
- if(wxPendingEventsLocker)
- wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
+ if (wxHandlersWithPendingEventsLocker)
+ wxENTER_CRIT_SECT(*wxHandlersWithPendingEventsLocker);
+#endif
+
+ if ( wxHandlersWithPendingEvents->DeleteObject(this) )
+ {
+ // check that we were present only once in the list
+ wxASSERT_MSG( !wxHandlersWithPendingEvents->Find(this),
+ "Handler occurs twice in wxHandlersWithPendingEvents list" );
+ }
+ //else: we weren't in this list at all, it's ok
+
+#if wxUSE_THREADS
+ if (wxHandlersWithPendingEventsLocker)
+ wxLEAVE_CRIT_SECT(*wxHandlersWithPendingEventsLocker);
#endif
+ }
// we only delete object data, not untyped
if ( m_clientDataType == wxClientData_Object )
#if wxUSE_THREADS
-bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
+bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event)
{
// check that we are really in a child thread
wxASSERT_MSG( !wxThread::IsMain(),
return true;
}
-void wxEvtHandler::ClearEventLocker()
-{
-#if !defined(__VISAGECPP__)
- delete m_eventsLocker;
- m_eventsLocker = NULL;
-#endif
-};
-
#endif // wxUSE_THREADS
-void wxEvtHandler::AddPendingEvent(wxEvent& event)
+void wxEvtHandler::QueueEvent(wxEvent *event)
{
- // 1) Add event to list of pending events of this event handler
-
- wxEvent *eventCopy = event.Clone();
+ wxCHECK_RET( event, "NULL event can't be posted" );
- // we must be able to copy the events here so the event class must
- // implement Clone() properly instead of just providing a NULL stab for it
- wxCHECK_RET( eventCopy,
- _T("events of this type aren't supposed to be posted") );
-
- wxENTER_CRIT_SECT( Lock() );
+ // 1) Add this event to our list of pending events
+ wxENTER_CRIT_SECT( m_pendingEventsLock );
if ( !m_pendingEvents )
m_pendingEvents = new wxList;
- m_pendingEvents->Append(eventCopy);
-
- wxLEAVE_CRIT_SECT( Lock() );
+ m_pendingEvents->Append(event);
// 2) Add this event handler to list of event handlers that
// have pending events.
- wxENTER_CRIT_SECT(*wxPendingEventsLocker);
+ wxENTER_CRIT_SECT(*wxHandlersWithPendingEventsLocker);
- if ( !wxPendingEvents )
- wxPendingEvents = new wxList;
- wxPendingEvents->Append(this);
+ if ( !wxHandlersWithPendingEvents )
+ wxHandlersWithPendingEvents = new wxList;
+ if ( !wxHandlersWithPendingEvents->Find(this) )
+ wxHandlersWithPendingEvents->Append(this);
- wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
+ wxLEAVE_CRIT_SECT(*wxHandlersWithPendingEventsLocker);
- // 3) Inform the system that new pending events are somwehere,
+ // only release m_pendingEventsLock now because otherwise there is a race
+ // condition as described in the ticket #9093: we could process the event
+ // just added to m_pendingEvents in our ProcessPendingEvents() below before
+ // we had time to append this pointer to wxHandlersWithPendingEvents list; thus
+ // breaking the invariant that a handler should be in the list iff it has
+ // any pending events to process
+ wxLEAVE_CRIT_SECT( m_pendingEventsLock );
+
+ // 3) Inform the system that new pending events are somewhere,
// and that these should be processed in idle time.
wxWakeUpIdle();
}
void wxEvtHandler::ProcessPendingEvents()
{
- // this method is only called by wxApp if this handler does have pending
- // events
- wxCHECK_RET( m_pendingEvents,
- wxT("Please call wxApp::ProcessPendingEvents() instead") );
-
- wxENTER_CRIT_SECT( Lock() );
+ wxENTER_CRIT_SECT( m_pendingEventsLock );
- // remember last event to process during this iteration
- wxList::compatibility_iterator lastPendingNode = m_pendingEvents->GetLast();
+ // this method is only called by wxApp if this handler does have
+ // pending events
+ wxCHECK_RET( m_pendingEvents && !m_pendingEvents->IsEmpty(),
+ "should have pending events if called" );
wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
- while ( node )
- {
- wxEvent *event = (wxEvent *)node->GetData();
- m_pendingEvents->Erase(node);
-
- // In ProcessEvent, new events might get added and
- // we can safely leave the crtical section here.
- wxLEAVE_CRIT_SECT( Lock() );
- ProcessEvent(*event);
- delete event;
- wxENTER_CRIT_SECT( Lock() );
-
- // leave the loop once we have processed all events that were present
- // at the start of ProcessPendingEvents because otherwise we could get
- // into infinite loop if the pending event handler execution resulted
- // in another event being posted
- if ( node == lastPendingNode )
- break;
+ wxEventPtr event(static_cast<wxEvent *>(node->GetData()));
+
+ // it's important we remove event from list before processing it, else a
+ // nested event loop, for example from a modal dialog, might process the
+ // same event again.
+ m_pendingEvents->Erase(node);
- node = m_pendingEvents->GetFirst();
+ // if there are no more pending events left, we don't need to stay in this
+ // list
+ if ( m_pendingEvents->IsEmpty() )
+ {
+#if wxUSE_THREADS
+ if (wxHandlersWithPendingEventsLocker)
+ wxENTER_CRIT_SECT(*wxHandlersWithPendingEventsLocker);
+#endif
+ wxHandlersWithPendingEvents->DeleteObject(this);
+#if wxUSE_THREADS
+ if (wxHandlersWithPendingEventsLocker)
+ wxLEAVE_CRIT_SECT(*wxHandlersWithPendingEventsLocker);
+#endif
}
- wxLEAVE_CRIT_SECT( Lock() );
+ wxLEAVE_CRIT_SECT( m_pendingEventsLock );
+
+ ProcessEvent(*event);
+
+ // careful: this object could have been deleted by the event handler
+ // executed by the above ProcessEvent() call, so we can't access any fields
+ // of this object any more
}
/*
bool wxEvtHandler::TryParent(wxEvent& event)
{
+ if ( GetNextHandler() )
+ {
+ // the next handler will pass it to wxTheApp if it doesn't process it,
+ // so return from here to avoid doing it again
+ return GetNextHandler()->TryParent(event);
+ }
+
if ( wxTheApp && (this != wxTheApp) )
{
// Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
//else: proceed normally
}
+ if ( ProcessEventHere(event) )
+ return true;
+
+ // propagate the event upwards the window chain and/or to the application
+ // object if it wasn't processed at this level
+ return TryParent(event);
+}
+
+bool wxEvtHandler::ProcessEventHere(wxEvent& event)
+{
// An event handler can be enabled or disabled
if ( GetEvtHandlerEnabled() )
{
}
// Try going down the event handler chain
- if ( GetNextHandler() )
+ if ( GetNextHandler() && GetNextHandler()->ProcessEventHere(event) )
+ return true;
+
+ // We don't have a handler for this event.
+ return false;
+}
+
+bool wxEvtHandler::SafelyProcessEvent(wxEvent& event)
+{
+#if wxUSE_EXCEPTIONS
+ try
{
- if ( GetNextHandler()->ProcessEvent(event) )
- return true;
+#endif
+ return ProcessEvent(event);
+#if wxUSE_EXCEPTIONS
}
+ catch ( ... )
+ {
+ wxEventLoopBase *loop = wxEventLoopBase::GetActive();
+ try
+ {
+ if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() )
+ {
+ if ( loop )
+ loop->Exit();
+ }
+ //else: continue running current event loop
- // Finally propagate the event upwards the window chain and/or to the
- // application object as necessary
- return TryParent(event);
+ return false;
+ }
+ catch ( ... )
+ {
+ // OnExceptionInMainLoop() threw, possibly rethrowing the same
+ // exception again: very good, but we still need Exit() to
+ // be called
+ if ( loop )
+ loop->Exit();
+ throw;
+ }
+ }
+#endif // wxUSE_EXCEPTIONS
}
}
void wxEvtHandler::Connect( int id, int lastId,
- int eventType,
+ wxEventType eventType,
wxObjectEventFunction func,
wxObject *userData,
wxEvtHandler* eventSink )
{
-#if WXWIN_COMPATIBILITY_EVENT_TYPES
- wxEventTableEntry *entry = new wxEventTableEntry;
- entry->m_eventType = eventType;
- entry->m_id = id;
- entry->m_lastId = lastId;
- entry->m_fn = func;
- entry->m_callbackUserData = userData;
-#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
wxDynamicEventTableEntry *entry =
new wxDynamicEventTableEntry(eventType, id, lastId, func, userData, eventSink);
-#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
if (!m_dynamicEvents)
m_dynamicEvents = new wxList;
// Insert at the front of the list so most recent additions are found first
m_dynamicEvents->Insert( (wxObject*) entry );
+
+ // Make sure we get to know when a sink is destroyed
+ if ( eventSink && eventSink != this )
+ {
+ wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
+ if ( evtConnRef )
+ evtConnRef->IncRef( );
+ else
+ new wxEventConnectionRef(this, eventSink);
+ }
}
bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType,
if (!m_dynamicEvents)
return false;
+ // Remove connection from tracker node (wxEventConnectionRef)
+ if ( eventSink && eventSink != this )
+ {
+ wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
+ if ( evtConnRef )
+ evtConnRef->DecRef();
+ }
+
wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
while (node)
{
-#if WXWIN_COMPATIBILITY_EVENT_TYPES
- wxEventTableEntry *entry = (wxEventTableEntry*)node->GetData();
-#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
- wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
-#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
+ wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
if ((entry->m_id == id) &&
((entry->m_lastId == lastId) || (lastId == wxID_ANY)) &&
wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
while (node)
{
-#if WXWIN_COMPATIBILITY_EVENT_TYPES
- wxEventTableEntry *entry = (wxEventTableEntry*)node->GetData();
-#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
-#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
+
+ // get next node before (maybe) calling the event handler as it could
+ // call Disconnect() invalidating the current node
+ node = node->GetNext();
if ((event.GetEventType() == entry->m_eventType) && (entry->m_fn != 0))
{
- wxEvtHandler *handler =
-#if !WXWIN_COMPATIBILITY_EVENT_TYPES
- entry->m_eventSink ? entry->m_eventSink
- :
-#endif
- this;
-
+ wxEvtHandler *handler = entry->m_eventSink ? entry->m_eventSink
+ : this;
if ( ProcessEventIfMatches(*entry, handler, event) )
- {
return true;
- }
}
-
- node = node->GetNext();
}
return false;
-};
+}
void wxEvtHandler::DoSetClientObject( wxClientData *data )
{
return m_clientData;
}
+// A helper to find an wxEventConnectionRef object
+wxEventConnectionRef *
+wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink)
+{
+ for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt )
+ {
+ // we only want wxEventConnectionRef nodes here
+ wxEventConnectionRef *evtConnRef = node->ToEventConnection();
+ if ( evtConnRef && evtConnRef->m_src == this )
+ {
+ wxASSERT( evtConnRef->m_sink==eventSink );
+ return evtConnRef;
+ }
+ }
+
+ return NULL;
+}
+
+void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink )
+{
+ wxASSERT(m_dynamicEvents);
+
+ // remove all connections with this sink
+ wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt;
+ while (node)
+ {
+ wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
+ node_nxt = node->GetNext();
+
+ if ( entry->m_eventSink==sink )
+ {
+ if (entry->m_callbackUserData)
+ delete entry->m_callbackUserData;
+ m_dynamicEvents->Erase( node );
+ delete entry;
+ }
+ node = node_nxt;
+ }
+}
+
#endif // wxUSE_BASE
#if wxUSE_GUI
return focusWin;
}
+// ----------------------------------------------------------------------------
+// wxEventBlocker
+// ----------------------------------------------------------------------------
+
+wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type)
+{
+ wxCHECK_RET(win, wxT("Null window given to wxEventBlocker"));
+
+ m_window = win;
+
+ Block(type);
+ m_window->PushEventHandler(this);
+}
+
+wxEventBlocker::~wxEventBlocker()
+{
+ wxEvtHandler *popped = m_window->PopEventHandler(false);
+ wxCHECK_RET(popped == this,
+ wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
+}
+
+bool wxEventBlocker::ProcessEvent(wxEvent& event)
+{
+ // should this event be blocked?
+ for ( size_t i = 0; i < m_eventsToBlock.size(); i++ )
+ {
+ wxEventType t = (wxEventType)m_eventsToBlock[i];
+ if ( t == wxEVT_ANY || t == event.GetEventType() )
+ return true; // yes, it should: mark this event as processed
+ }
+
+ return false;
+}
+
#endif // wxUSE_GUI
projects / wxWidgets.git / blobdiff