// Created: 01.06.01
// RCS-ID: $Id$
// Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// License: wxWindows license
+// License: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "evtloop.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#pragma hdrstop
#endif
+#include "wx/evtloop.h"
+
#ifndef WX_PRECOMP
+ #if wxUSE_GUI
+ #include "wx/window.h"
+ #endif
+ #include "wx/app.h"
+ #include "wx/log.h"
#endif //WX_PRECOMP
-#include "wx/evtloop.h"
-#include "wx/window.h"
-#include "wx/app.h"
-
+#include "wx/thread.h"
+#include "wx/except.h"
#include "wx/msw/private.h"
+#include "wx/scopeguard.h"
-// ----------------------------------------------------------------------------
-// wxEventLoopImpl
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxEventLoopImpl
-{
-public:
- // ctor
- wxEventLoopImpl() { SetExitCode(0); }
-
- // process a message
- void ProcessMessage(MSG *msg);
+#if wxUSE_GUI
+ #include "wx/tooltip.h"
+ #if wxUSE_THREADS
+ // define the list of MSG strutures
+ WX_DECLARE_LIST(MSG, wxMsgList);
- // generate an idle message, return TRUE if more idle time requested
- bool SendIdleMessage();
+ #include "wx/listimpl.cpp"
- // set/get the exit code
- void SetExitCode(int exitcode) { m_exitcode = exitcode; }
- int GetExitCode() const { return m_exitcode; }
+ WX_DEFINE_LIST(wxMsgList)
+ #endif // wxUSE_THREADS
+#endif //wxUSE_GUI
-private:
- // preprocess a message, return TRUE if processed (i.e. no further
- // dispatching required)
- bool PreProcessMessage(MSG *msg);
-
- // the exit code of the event loop
- int m_exitcode;
-};
+#if wxUSE_BASE
// ============================================================================
-// wxEventLoopImpl implementation
+// wxMSWEventLoopBase implementation
// ============================================================================
// ----------------------------------------------------------------------------
-// wxEventLoopImpl message processing
+// ctor/dtor
// ----------------------------------------------------------------------------
-void wxEventLoopImpl::ProcessMessage(MSG *msg)
+wxMSWEventLoopBase::wxMSWEventLoopBase()
{
- // give us the chance to preprocess the message first
- if ( !PreProcessMessage(msg) )
- {
- // if it wasn't done, dispatch it to the corresponding window
- ::TranslateMessage(msg);
- ::DispatchMessage(msg);
- }
+ m_shouldExit = false;
+ m_exitcode = 0;
}
-bool wxEventLoopImpl::PreProcessMessage(MSG *msg)
+// ----------------------------------------------------------------------------
+// wxEventLoop message processing dispatching
+// ----------------------------------------------------------------------------
+
+bool wxMSWEventLoopBase::Pending() const
{
- HWND hWnd = msg->hwnd;
- wxWindow *wndThis = wxGetWindowFromHWND((WXHWND)hWnd);
+ MSG msg;
+ return ::PeekMessage(&msg, 0, 0, 0, PM_NOREMOVE) != 0;
+}
-#if wxUSE_TOOLTIPS
- // we must relay WM_MOUSEMOVE events to the tooltip ctrl if we want it to
- // popup the tooltip bubbles
- if ( wndThis && (msg->message == WM_MOUSEMOVE) )
+bool wxMSWEventLoopBase::GetNextMessage(WXMSG* msg)
+{
+ const BOOL rc = ::GetMessage(msg, NULL, 0, 0);
+
+ if ( rc == 0 )
{
- wxToolTip *tt = wndThis->GetToolTip();
- if ( tt )
- {
- tt->RelayEvent((WXMSG *)msg);
- }
+ // got WM_QUIT
+ return false;
}
-#endif // wxUSE_TOOLTIPS
- // try translations first; find the youngest window with a translation
- // table.
- wxWindow *wnd;
- for ( wnd = wndThis; wnd; wnd = wnd->GetParent() )
+ if ( rc == -1 )
{
- if ( wnd->MSWTranslateMessage((WXMSG *)msg) )
- return TRUE;
+ // should never happen, but let's test for it nevertheless
+ wxLogLastError(wxT("GetMessage"));
+
+ // still break from the loop
+ return false;
}
- // Anyone for a non-translation message? Try youngest descendants first.
- for ( wnd = wndThis; wnd; wnd = wnd->GetParent() )
+ return true;
+}
+
+int wxMSWEventLoopBase::GetNextMessageTimeout(WXMSG *msg, unsigned long timeout)
+{
+ // MsgWaitForMultipleObjects() won't notice any input which was already
+ // examined (e.g. using PeekMessage()) but not yet removed from the queue
+ // so we need to remove any immediately messages manually
+ //
+ // NB: using MsgWaitForMultipleObjectsEx() could simplify the code here but
+ // it is not available in very old Windows versions
+ if ( !::PeekMessage(msg, 0, 0, 0, PM_REMOVE) )
{
- if ( wnd->MSWProcessMessage((WXMSG *)msg) )
- return TRUE;
+ // we use this function just in order to not block longer than the
+ // given timeout, so we don't pass any handles to it at all
+ DWORD rc = ::MsgWaitForMultipleObjects
+ (
+ 0, NULL,
+ FALSE,
+ timeout,
+ QS_ALLINPUT
+ );
+
+ switch ( rc )
+ {
+ default:
+ wxLogDebug("unexpected MsgWaitForMultipleObjects() return "
+ "value %lu", rc);
+ // fall through
+
+ case WAIT_TIMEOUT:
+ return -1;
+
+ case WAIT_OBJECT_0:
+ if ( !::PeekMessage(msg, 0, 0, 0, PM_REMOVE) )
+ {
+ // somehow it may happen that MsgWaitForMultipleObjects()
+ // returns true but there are no messages -- just treat it
+ // the same as timeout then
+ return -1;
+ }
+ break;
+ }
}
- return FALSE;
+ return msg->message != WM_QUIT;
}
-// ----------------------------------------------------------------------------
-// wxEventLoopImpl idle event processing
-// ----------------------------------------------------------------------------
-bool wxEventLoopImpl::SendIdleMessage()
-{
- wxIdleEvent event;
+#endif // wxUSE_BASE
- return wxTheApp->ProcessEvent(event) && event.MoreRequested();
-}
+#if wxUSE_GUI
// ============================================================================
-// wxEventLoop implementation
+// GUI wxEventLoop implementation
// ============================================================================
-// ----------------------------------------------------------------------------
-// wxEventLoop running and exiting
-// ----------------------------------------------------------------------------
+wxWindowMSW *wxGUIEventLoop::ms_winCritical = NULL;
-wxEventLoop::~wxEventLoop()
+bool wxGUIEventLoop::IsChildOfCriticalWindow(wxWindowMSW *win)
{
- wxASSERT_MSG( !m_impl, _T("should have been deleted in Run()") );
-}
+ while ( win )
+ {
+ if ( win == ms_winCritical )
+ return true;
-bool wxEventLoop::IsRunning() const
-{
- return m_impl != NULL;
+ win = win->GetParent();
+ }
+
+ return false;
}
-int wxEventLoop::Run()
+bool wxGUIEventLoop::PreProcessMessage(WXMSG *msg)
{
- // event loops are not recursive, you need to create another loop!
- wxCHECK_MSG( !IsRunning(), -1, _T("can't reenter a message loop") );
-
- m_impl = new wxEventLoopImpl;
+ HWND hwnd = msg->hwnd;
+ wxWindow *wndThis = wxGetWindowFromHWND((WXHWND)hwnd);
+ wxWindow *wnd;
- for ( ;; )
+ // this might happen if we're in a modeless dialog, or if a wx control has
+ // children which themselves were not created by wx (i.e. wxActiveX control children)
+ if ( !wndThis )
{
-#if wxUSE_THREADS
- wxMutexGuiLeaveOrEnter();
-#endif // wxUSE_THREADS
+ while ( hwnd && (::GetWindowLong(hwnd, GWL_STYLE) & WS_CHILD ))
+ {
+ hwnd = ::GetParent(hwnd);
- // generate and process idle events for as long as we don't have
- // anything else to do
- while ( !Pending() && m_impl->SendIdleMessage() )
- ;
+ // If the control has a wx parent, break and give the parent a chance
+ // to process the window message
+ wndThis = wxGetWindowFromHWND((WXHWND)hwnd);
+ if (wndThis != NULL)
+ break;
+ }
- // a message came or no more idle processing to do, sit in Dispatch()
- // waiting for the next message
- if ( !Dispatch() )
+ if ( !wndThis )
{
- // we got WM_QUIT
- break;
+ // this may happen if the event occurred in a standard modeless dialog (the
+ // only example of which I know of is the find/replace dialog) - then call
+ // IsDialogMessage() to make TAB navigation in it work
+
+ // NOTE: IsDialogMessage() just eats all the messages (i.e. returns true for
+ // them) if we call it for the control itself
+ return hwnd && ::IsDialogMessage(hwnd, msg) != 0;
}
}
- int exitcode = m_impl->GetExitCode();
- delete m_impl;
- m_impl = NULL;
+ if ( !AllowProcessing(wndThis) )
+ {
+ // not a child of critical window, so we eat the event but take care to
+ // stop an endless stream of WM_PAINTs which would have resulted if we
+ // didn't validate the invalidated part of the window
+ if ( msg->message == WM_PAINT )
+ ::ValidateRect(hwnd, NULL);
- return exitcode;
-}
+ return true;
+ }
-void wxEventLoop::Exit(int rc)
-{
- wxCHECK_RET( IsRunning(), _T("can't call Exit() if not running") );
+#if wxUSE_TOOLTIPS
+ // we must relay WM_MOUSEMOVE events to the tooltip ctrl if we want it to
+ // popup the tooltip bubbles
+ if ( msg->message == WM_MOUSEMOVE )
+ {
+ // we should do it if one of window children has an associated tooltip
+ // (and not just if the window has a tooltip itself)
+ if ( wndThis->HasToolTips() )
+ wxToolTip::RelayEvent((WXMSG *)msg);
+ }
+#endif // wxUSE_TOOLTIPS
- m_impl->SetExitCode(rc);
+ // allow the window to prevent certain messages from being
+ // translated/processed (this is currently used by wxTextCtrl to always
+ // grab Ctrl-C/V/X, even if they are also accelerators in some parent)
+ if ( !wndThis->MSWShouldPreProcessMessage((WXMSG *)msg) )
+ {
+ return false;
+ }
- ::PostQuitMessage(rc);
-}
+ // try translations first: the accelerators override everything
+ for ( wnd = wndThis; wnd; wnd = wnd->GetParent() )
+ {
+ if ( wnd->MSWTranslateMessage((WXMSG *)msg))
+ return true;
-// ----------------------------------------------------------------------------
-// wxEventLoop message processing dispatching
-// ----------------------------------------------------------------------------
+ // stop at first top level window, i.e. don't try to process the key
+ // strokes originating in a dialog using the accelerators of the parent
+ // frame - this doesn't make much sense
+ if ( wnd->IsTopLevel() )
+ break;
+ }
-bool wxEventLoop::Pending() const
-{
- MSG msg;
- return ::PeekMessage(&msg, 0, 0, 0, PM_NOREMOVE) != 0;
-}
+ // now try the other hooks (kbd navigation is handled here)
+ for ( wnd = wndThis; wnd; wnd = wnd->GetParent() )
+ {
+ if ( wnd->MSWProcessMessage((WXMSG *)msg) )
+ return true;
-bool wxEventLoop::Dispatch()
-{
- wxCHECK_MSG( IsRunning(), FALSE, _T("can't call Dispatch() if not running") );
+ // also stop at first top level window here, just as above because
+ // if we don't do this, pressing ESC on a modal dialog shown as child
+ // of a modal dialog with wxID_CANCEL will cause the parent dialog to
+ // be closed, for example
+ if ( wnd->IsTopLevel() )
+ break;
+ }
- MSG msg;
- BOOL rc = ::GetMessage(&msg, (HWND) NULL, 0, 0);
+ // no special preprocessing for this message, dispatch it normally
+ return false;
+}
- if ( rc == 0 )
+void wxGUIEventLoop::ProcessMessage(WXMSG *msg)
+{
+ // give us the chance to preprocess the message first
+ if ( !PreProcessMessage(msg) )
{
- // got WM_QUIT
- return FALSE;
+ // if it wasn't done, dispatch it to the corresponding window
+ ::TranslateMessage(msg);
+ ::DispatchMessage(msg);
}
+}
- if ( rc == -1 )
- {
- // should never happen, but let's test for it nevertheless
- wxLogLastError(wxT("GetMessage"));
-
- // still break from the loop
- return FALSE;
- }
+bool wxGUIEventLoop::Dispatch()
+{
+ MSG msg;
+ if ( !GetNextMessage(&msg) )
+ return false;
#if wxUSE_THREADS
wxASSERT_MSG( wxThread::IsMain(),
wxT("only the main thread can process Windows messages") );
- static bool s_hadGuiLock = TRUE;
- static wxMsgArray s_aSavedMessages;
+ static bool s_hadGuiLock = true;
+ static wxMsgList s_aSavedMessages;
// if a secondary thread owning the mutex is doing GUI calls, save all
// messages for later processing - we can't process them right now because
// it will lead to recursive library calls (and we're not reentrant)
if ( !wxGuiOwnedByMainThread() )
{
- s_hadGuiLock = FALSE;
+ s_hadGuiLock = false;
// leave out WM_COMMAND messages: too dangerous, sometimes
// the message will be processed twice
- if ( !wxIsWaitingForThread() ||
- s_currentMsg.message != WM_COMMAND )
+ if ( !wxIsWaitingForThread() || msg.message != WM_COMMAND )
{
- s_aSavedMessages.Add(s_currentMsg);
+ MSG* pMsg = new MSG(msg);
+ s_aSavedMessages.Append(pMsg);
}
- return TRUE;
+ return true;
}
else
{
// messages normally - expect some things to break...
if ( !s_hadGuiLock )
{
- s_hadGuiLock = TRUE;
+ s_hadGuiLock = true;
- size_t count = s_aSavedMessages.Count();
- for ( size_t n = 0; n < count; n++ )
+ wxMsgList::compatibility_iterator node = s_aSavedMessages.GetFirst();
+ while (node)
{
- MSG& msg = s_aSavedMessages[n];
- m_impl->ProcessMessage(&msg);
- }
+ MSG* pMsg = node->GetData();
+ s_aSavedMessages.Erase(node);
- s_aSavedMessages.Empty();
+ ProcessMessage(pMsg);
+ delete pMsg;
+
+ node = s_aSavedMessages.GetFirst();
+ }
}
}
#endif // wxUSE_THREADS
- m_impl->ProcessMessage(&msg);
+ ProcessMessage(&msg);
- return TRUE;
+ return true;
}
+int wxGUIEventLoop::DispatchTimeout(unsigned long timeout)
+{
+ MSG msg;
+ int rc = GetNextMessageTimeout(&msg, timeout);
+ if ( rc != 1 )
+ return rc;
+
+ ProcessMessage(&msg);
+
+ return 1;
+}
+
+void wxGUIEventLoop::OnNextIteration()
+{
+#if wxUSE_THREADS
+ wxMutexGuiLeaveOrEnter();
+#endif // wxUSE_THREADS
+}
+
+void wxGUIEventLoop::WakeUp()
+{
+ ::PostMessage(NULL, WM_NULL, 0, 0);
+}
+
+
+// ----------------------------------------------------------------------------
+// Yield to incoming messages
+// ----------------------------------------------------------------------------
+
+#include <wx/arrimpl.cpp>
+WX_DEFINE_OBJARRAY(wxMSGArray);
+
+bool wxGUIEventLoop::YieldFor(long eventsToProcess)
+{
+ // set the flag and don't forget to reset it before returning
+ m_isInsideYield = true;
+ m_eventsToProcessInsideYield = eventsToProcess;
+
+ wxON_BLOCK_EXIT_SET(m_isInsideYield, false);
+
+#if wxUSE_LOG
+ // disable log flushing from here because a call to wxYield() shouldn't
+ // normally result in message boxes popping up &c
+ wxLog::Suspend();
+
+ // ensure the logs will be flashed again when we exit
+ wxON_BLOCK_EXIT0(wxLog::Resume);
+#endif // wxUSE_LOG
+
+ // we don't want to process WM_QUIT from here - it should be processed in
+ // the main event loop in order to stop it
+ MSG msg;
+ int nPaintsReceived = 0;
+ while ( PeekMessage(&msg, (HWND)0, 0, 0, PM_NOREMOVE) &&
+ msg.message != WM_QUIT )
+ {
+#if wxUSE_THREADS
+ wxMutexGuiLeaveOrEnter();
+#endif // wxUSE_THREADS
+
+ if (msg.message == WM_PAINT)
+ {
+ // NOTE: WM_PAINTs are categorized as wxEVT_CATEGORY_UI
+ if ((eventsToProcess & wxEVT_CATEGORY_UI) == 0)
+ {
+ // this msg is not going to be dispatched...
+ // however WM_PAINT is special: until there are damaged
+ // windows, Windows will keep sending it forever!
+ if (nPaintsReceived > 10)
+ {
+ // we got 10 WM_PAINT consecutive messages...
+ // we must have reached the tail of the message queue:
+ // we're now getting _only_ WM_PAINT events and this will
+ // continue forever (since we don't dispatch them
+ // because of the user-specified eventsToProcess mask)...
+ // break out of this loop!
+ break;
+ }
+ else
+ nPaintsReceived++;
+ }
+ //else: we're going to dispatch it below,
+ // so we don't need to take any special action
+ }
+ else
+ {
+ // reset the counter of consecutive WM_PAINT messages received:
+ nPaintsReceived = 0;
+ }
+
+ // choose a wxEventCategory for this Windows message
+ wxEventCategory cat;
+ switch (msg.message)
+ {
+#if !defined(__WXWINCE__)
+ case WM_NCMOUSEMOVE:
+
+ case WM_NCLBUTTONDOWN:
+ case WM_NCLBUTTONUP:
+ case WM_NCLBUTTONDBLCLK:
+ case WM_NCRBUTTONDOWN:
+ case WM_NCRBUTTONUP:
+ case WM_NCRBUTTONDBLCLK:
+ case WM_NCMBUTTONDOWN:
+ case WM_NCMBUTTONUP:
+ case WM_NCMBUTTONDBLCLK:
+#endif
+
+ case WM_KEYDOWN:
+ case WM_KEYUP:
+ case WM_CHAR:
+ case WM_DEADCHAR:
+ case WM_SYSKEYDOWN:
+ case WM_SYSKEYUP:
+ case WM_SYSCHAR:
+ case WM_SYSDEADCHAR:
+#ifdef WM_UNICHAR
+ case WM_UNICHAR:
+#endif
+ case WM_HOTKEY:
+ case WM_IME_STARTCOMPOSITION:
+ case WM_IME_ENDCOMPOSITION:
+ case WM_IME_COMPOSITION:
+ case WM_COMMAND:
+ case WM_SYSCOMMAND:
+
+ case WM_IME_SETCONTEXT:
+ case WM_IME_NOTIFY:
+ case WM_IME_CONTROL:
+ case WM_IME_COMPOSITIONFULL:
+ case WM_IME_SELECT:
+ case WM_IME_CHAR:
+ case WM_IME_KEYDOWN:
+ case WM_IME_KEYUP:
+
+#if !defined(__WXWINCE__)
+ case WM_MOUSEHOVER:
+ case WM_MOUSELEAVE:
+#endif
+#ifdef WM_NCMOUSELEAVE
+ case WM_NCMOUSELEAVE:
+#endif
+
+ case WM_CUT:
+ case WM_COPY:
+ case WM_PASTE:
+ case WM_CLEAR:
+ case WM_UNDO:
+
+ case WM_MOUSEMOVE:
+ case WM_LBUTTONDOWN:
+ case WM_LBUTTONUP:
+ case WM_LBUTTONDBLCLK:
+ case WM_RBUTTONDOWN:
+ case WM_RBUTTONUP:
+ case WM_RBUTTONDBLCLK:
+ case WM_MBUTTONDOWN:
+ case WM_MBUTTONUP:
+ case WM_MBUTTONDBLCLK:
+ case WM_MOUSEWHEEL:
+ cat = wxEVT_CATEGORY_USER_INPUT;
+ break;
+
+ case WM_TIMER:
+ cat = wxEVT_CATEGORY_TIMER;
+ break;
+
+ default:
+ if (msg.message < WM_USER)
+ {
+ // 0;WM_USER-1 is the range of message IDs reserved for use
+ // by the system.
+ // there are too many of these types of messages to handle
+ // them in this switch
+ cat = wxEVT_CATEGORY_UI;
+ }
+ else
+ cat = wxEVT_CATEGORY_UNKNOWN;
+ }
+
+ // should we process this event now?
+ if (cat & eventsToProcess)
+ {
+ if ( !wxTheApp->Dispatch() )
+ break;
+ }
+ else
+ {
+ // remove the message and store it
+ ::GetMessage(&msg, NULL, 0, 0);
+ m_arrMSG.Add(msg);
+ }
+ }
+
+ // if there are pending events, we must process them.
+ if (wxTheApp)
+ wxTheApp->ProcessPendingEvents();
+
+ // put back unprocessed events in the queue
+ DWORD id = GetCurrentThreadId();
+ for (size_t i=0; i<m_arrMSG.GetCount(); i++)
+ {
+ PostThreadMessage(id, m_arrMSG[i].message,
+ m_arrMSG[i].wParam, m_arrMSG[i].lParam);
+ }
+
+ m_arrMSG.Clear();
+
+ return true;
+}
+
+
+#else // !wxUSE_GUI
+
+
+// ============================================================================
+// wxConsoleEventLoop implementation
+// ============================================================================
+
+#if wxUSE_CONSOLE_EVENTLOOP
+
+void wxConsoleEventLoop::WakeUp()
+{
+#if wxUSE_THREADS
+ wxWakeUpMainThread();
+#endif
+}
+
+void wxConsoleEventLoop::ProcessMessage(WXMSG *msg)
+{
+ ::DispatchMessage(msg);
+}
+
+bool wxConsoleEventLoop::Dispatch()
+{
+ MSG msg;
+ if ( !GetNextMessage(&msg) )
+ return false;
+
+ ProcessMessage(&msg);
+
+ return !m_shouldExit;
+}
+
+int wxConsoleEventLoop::DispatchTimeout(unsigned long timeout)
+{
+ MSG msg;
+ int rc = GetNextMessageTimeout(&msg, timeout);
+ if ( rc != 1 )
+ return rc;
+
+ ProcessMessage(&msg);
+
+ return !m_shouldExit;
+}
+
+#endif // wxUSE_CONSOLE_EVENTLOOP
+
+#endif //wxUSE_GUI
projects / wxWidgets.git / blobdiff