]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/evtloop.cpp
Add some version checks to help compiling on OSX.
[wxWidgets.git] / src / msw / evtloop.cpp
index c260f52ea2b3074c05b6328c6512b88e5f37b306..6e734bc53f19955202266623ae3e22708a84b5ad 100644 (file)
@@ -1,12 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        msw/evtloop.cpp
+// Name:        src/msw/evtloop.cpp
 // Purpose:     implements wxEventLoop for MSW
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     01.06.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// License:     wxWindows licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
     #pragma hdrstop
 #endif
 
+#include "wx/evtloop.h"
+
 #ifndef WX_PRECOMP
-    #include "wx/window.h"
+    #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/tooltip.h"
+#include "wx/thread.h"
 #include "wx/except.h"
-#include "wx/ptr_scpd.h"
-
 #include "wx/msw/private.h"
+#include "wx/scopeguard.h"
 
-#if wxUSE_THREADS
-    #include "wx/thread.h"
+#if wxUSE_GUI
+    #include "wx/tooltip.h"
+    #if wxUSE_THREADS
+        // define the list of MSG strutures
+        WX_DECLARE_LIST(MSG, wxMsgList);
 
-    // define the list of MSG strutures
-    WX_DECLARE_LIST(MSG, wxMsgList);
+        #include "wx/listimpl.cpp"
 
-    #include "wx/listimpl.cpp"
+        WX_DEFINE_LIST(wxMsgList)
+    #endif // wxUSE_THREADS
+#endif //wxUSE_GUI
 
-    WX_DEFINE_LIST(wxMsgList)
-#endif // wxUSE_THREADS
+#if wxUSE_BASE
 
 // ============================================================================
-// wxEventLoop implementation
+// wxMSWEventLoopBase implementation
 // ============================================================================
 
-wxWindowMSW *wxEventLoop::ms_winCritical = NULL;
-
 // ----------------------------------------------------------------------------
 // ctor/dtor
 // ----------------------------------------------------------------------------
 
-wxEventLoop::wxEventLoop()
+wxMSWEventLoopBase::wxMSWEventLoopBase()
 {
     m_shouldExit = false;
     m_exitcode = 0;
 }
 
 // ----------------------------------------------------------------------------
-// wxEventLoop message processing
+// wxEventLoop message processing dispatching
 // ----------------------------------------------------------------------------
 
-void wxEventLoop::ProcessMessage(WXMSG *msg)
+bool wxMSWEventLoopBase::Pending() const
 {
-    // give us the chance to preprocess the message first
-    if ( !PreProcessMessage(msg) )
+    MSG msg;
+    return ::PeekMessage(&msg, 0, 0, 0, PM_NOREMOVE) != 0;
+}
+
+bool wxMSWEventLoopBase::GetNextMessage(WXMSG* msg)
+{
+    const BOOL rc = ::GetMessage(msg, NULL, 0, 0);
+
+    if ( rc == 0 )
     {
-        // if it wasn't done, dispatch it to the corresponding window
-        ::TranslateMessage(msg);
-        ::DispatchMessage(msg);
+        // got WM_QUIT
+        return false;
     }
+
+    if ( rc == -1 )
+    {
+        // should never happen, but let's test for it nevertheless
+        wxLogLastError(wxT("GetMessage"));
+
+        // still break from the loop
+        return false;
+    }
+
+    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) )
+    {
+        // 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 msg->message != WM_QUIT;
 }
 
-bool wxEventLoop::IsChildOfCriticalWindow(wxWindowMSW *win)
+
+#endif // wxUSE_BASE
+
+#if wxUSE_GUI
+
+// ============================================================================
+// GUI wxEventLoop implementation
+// ============================================================================
+
+wxWindowMSW *wxGUIEventLoop::ms_winCritical = NULL;
+
+bool wxGUIEventLoop::IsChildOfCriticalWindow(wxWindowMSW *win)
 {
     while ( win )
     {
@@ -92,7 +168,7 @@ bool wxEventLoop::IsChildOfCriticalWindow(wxWindowMSW *win)
     return false;
 }
 
-bool wxEventLoop::PreProcessMessage(WXMSG *msg)
+bool wxGUIEventLoop::PreProcessMessage(WXMSG *msg)
 {
     HWND hwnd = msg->hwnd;
     wxWindow *wndThis = wxGetWindowFromHWND((WXHWND)hwnd);
@@ -172,16 +248,14 @@ bool wxEventLoop::PreProcessMessage(WXMSG *msg)
     // now try the other hooks (kbd navigation is handled here)
     for ( wnd = wndThis; wnd; wnd = wnd->GetParent() )
     {
-        if (wnd != wndThis) // Skip the first since wndThis->MSWProcessMessage() was called above
-        {
-            if ( wnd->MSWProcessMessage((WXMSG *)msg) )
-                return true;
-        }
+        if ( wnd->MSWProcessMessage((WXMSG *)msg) )
+            return true;
 
-        // Stop at first top level window (as per comment above).
-        // 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())
+        // 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;
     }
 
@@ -189,57 +263,22 @@ bool wxEventLoop::PreProcessMessage(WXMSG *msg)
     return false;
 }
 
-// ----------------------------------------------------------------------------
-// wxEventLoop running and exiting
-// ----------------------------------------------------------------------------
-
-// ----------------------------------------------------------------------------
-// wxEventLoopManual customization
-// ----------------------------------------------------------------------------
-
-void wxEventLoop::OnNextIteration()
-{
-#if wxUSE_THREADS
-    wxMutexGuiLeaveOrEnter();
-#endif // wxUSE_THREADS
-}
-
-void wxEventLoop::WakeUp()
-{
-    ::PostMessage(NULL, WM_NULL, 0, 0);
-}
-
-// ----------------------------------------------------------------------------
-// wxEventLoop message processing dispatching
-// ----------------------------------------------------------------------------
-
-bool wxEventLoop::Pending() const
+void wxGUIEventLoop::ProcessMessage(WXMSG *msg)
 {
-    MSG msg;
-    return ::PeekMessage(&msg, 0, 0, 0, PM_NOREMOVE) != 0;
+    // 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);
+    }
 }
 
-bool wxEventLoop::Dispatch()
+bool wxGUIEventLoop::Dispatch()
 {
-    wxCHECK_MSG( IsRunning(), false, _T("can't call Dispatch() if not running") );
-
     MSG msg;
-    BOOL rc = ::GetMessage(&msg, (HWND) NULL, 0, 0);
-
-    if ( rc == 0 )
-    {
-        // got WM_QUIT
-        return false;
-    }
-
-    if ( rc == -1 )
-    {
-        // should never happen, but let's test for it nevertheless
-        wxLogLastError(wxT("GetMessage"));
-
-        // still break from the loop
+    if ( !GetNextMessage(&msg) )
         return false;
-    }
 
 #if wxUSE_THREADS
     wxASSERT_MSG( wxThread::IsMain(),
@@ -296,3 +335,262 @@ bool wxEventLoop::Dispatch()
     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