missing commit

[wxWidgets.git] / src / msw / evtloop.cpp

diff --git a/src/msw/evtloop.cpp b/src/msw/evtloop.cpp
index 78d4ee212e3f026fa314a7d87f72a2a6439d01a3..eb97f85bab7aa310e42551120f21b7a324cac0a3 100644 (file)
--- a/src/msw/evtloop.cpp
+++ b/src/msw/evtloop.cpp
@@ -1,12 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        msw/evtloop.cpp
-// Purpose:     implements wxEventLoop for MSW
+// Name:        src/msw/evtloop.cpp
+// Purpose:     implements wxEventLoop for wxMSW port

 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     01.06.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // 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

 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -24,129 +24,28 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#include "wx/evtloop.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #if wxUSE_GUI
-        #include "wx/window.h"
-    #endif
+    #include "wx/window.h"

     #include "wx/app.h"
     #include "wx/app.h"

+    #include "wx/log.h"

 #endif //WX_PRECOMP
 
 #endif //WX_PRECOMP
 

-#include "wx/evtloop.h"

 #include "wx/thread.h"
 #include "wx/except.h"
 #include "wx/msw/private.h"
 #include "wx/thread.h"
 #include "wx/except.h"
 #include "wx/msw/private.h"

+#include "wx/scopeguard.h"

 
 

-#if wxUSE_GUI
-    #include "wx/tooltip.h"
-    #if wxUSE_THREADS
-        // define the list of MSG strutures
-        WX_DECLARE_LIST(MSG, wxMsgList);
-
-        #include "wx/listimpl.cpp"
-
-        WX_DEFINE_LIST(wxMsgList)
-    #endif // wxUSE_THREADS
-#endif //wxUSE_GUI
-
-#if wxUSE_BASE
-
-// ============================================================================
-// wxMSWEventLoopBase implementation
-// ============================================================================
-
-// ----------------------------------------------------------------------------
-// ctor/dtor
-// ----------------------------------------------------------------------------
-
-wxMSWEventLoopBase::wxMSWEventLoopBase()
-{
-    m_shouldExit = false;
-    m_exitcode = 0;
-}
-
-// ----------------------------------------------------------------------------
-// wxEventLoop message processing dispatching
-// ----------------------------------------------------------------------------
-
-bool wxMSWEventLoopBase::Pending() const
-{
-    MSG msg;
-    return ::PeekMessage(&msg, 0, 0, 0, PM_NOREMOVE) != 0;
-}
-
-bool wxMSWEventLoopBase::GetNextMessage(WXMSG* msg)
-{
-    wxCHECK_MSG( IsRunning(), false, _T("can't get messages if not running") );
-
-    const BOOL rc = ::GetMessage(msg, 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
-        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;
-}
-
+#include "wx/tooltip.h"
+#if wxUSE_THREADS
+    // define the list of MSG strutures
+    WX_DECLARE_LIST(MSG, wxMsgList);

 
 

-#endif // wxUSE_BASE
+    #include "wx/listimpl.cpp"

 
 

-#if wxUSE_GUI
+    WX_DEFINE_LIST(wxMsgList)
+#endif // wxUSE_THREADS

 
 // ============================================================================
 // GUI wxEventLoop implementation
 
 // ============================================================================
 // GUI wxEventLoop implementation


@@ -358,54 +257,197 @@ void wxGUIEventLoop::WakeUp()
     ::PostMessage(NULL, WM_NULL, 0, 0);
 }
 
     ::PostMessage(NULL, WM_NULL, 0, 0);
 }
 

-#else // !wxUSE_GUI

 
 

-#if wxUSE_CONSOLE_EVENTLOOP
+// ----------------------------------------------------------------------------
+// Yield to incoming messages
+// ----------------------------------------------------------------------------

 
 

-void wxConsoleEventLoop::WakeUp()
+#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
 #if wxUSE_THREADS

-    wxWakeUpMainThread();
+        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
+        bool processNow;
+        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
 #endif

-}

 
 

-void wxConsoleEventLoop::ProcessMessage(WXMSG *msg)
-{
-    if ( msg->message == WM_TIMER )
-    {
-        TIMERPROC proc = (TIMERPROC)msg->lParam;
-        if ( proc )
-            (*proc)(NULL, 0, msg->wParam, 0);
-    }
-    else
-    {
-        ::DispatchMessage(msg);
-    }
-}
+            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

 
 

-bool wxConsoleEventLoop::Dispatch()
-{
-    MSG msg;
-    if ( !GetNextMessage(&msg) )
-        return false;
+            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:
+                processNow = (eventsToProcess & wxEVT_CATEGORY_USER_INPUT) != 0;
+                break;

 
 

-    ProcessMessage(&msg);
+            case WM_TIMER:
+                processNow = (eventsToProcess & wxEVT_CATEGORY_TIMER) != 0;
+                break;

 
 

-    return !m_shouldExit;
-}
+            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
+                    processNow = (eventsToProcess & wxEVT_CATEGORY_UI) != 0;
+                }
+                else
+                {
+                    // Process all the unknown messages. We must do it because
+                    // failure to process some of them can be fatal, e.g. if we
+                    // don't dispatch WM_APP+2 then embedded IE ActiveX
+                    // controls don't work any more, see #14027. And there may
+                    // be more examples like this, so dispatch all unknown
+                    // messages immediately to be safe.
+                    processNow = true;
+                }
+        }

 
 

-int wxConsoleEventLoop::DispatchTimeout(unsigned long timeout)
-{
-    MSG msg;
-    int rc = GetNextMessageTimeout(&msg, timeout);
-    if ( rc != 1 )
-        return rc;
+        // should we process this event now?
+        if ( processNow )
+        {
+            if ( !wxTheApp->Dispatch() )
+                break;
+        }
+        else
+        {
+            // remove the message and store it
+            ::GetMessage(&msg, NULL, 0, 0);
+            m_arrMSG.Add(msg);
+        }
+    }

 
 

-    ProcessMessage(&msg);
+    // if there are pending events, we must process them.
+    if (wxTheApp)
+        wxTheApp->ProcessPendingEvents();

 
 

-    return !m_shouldExit;
-}
+    // 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);
+    }

 
 

-#endif // wxUSE_CONSOLE_EVENTLOOP
+    m_arrMSG.Clear();

 
 

-#endif //wxUSE_GUI
+    return true;
+}