]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/evtloop.cpp
remove incorrect cast of wxString to char* (unnecessary and breaks wxUSE_STL build)
[wxWidgets.git] / src / msw / evtloop.cpp
index 2a4da8b4463926bca94bedd999af3a6be80c47ca..96e618066449a292e439f4a5c4a59c53f190c374 100644 (file)
 // headers
 // ----------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "evtloop.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #endif
 
 #ifndef WX_PRECOMP
-    #include "wx/window.h"
+    #if wxUSE_GUI
+        #include "wx/window.h"
+    #endif
     #include "wx/app.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"
 
-// For MB_TASKMODAL
-#ifdef __WXWINCE__
-#include "wx/msw/wince/missing.h"
-#endif
+#if wxUSE_GUI
+    #include "wx/tooltip.h"
+    #if wxUSE_THREADS
+        // define the list of MSG strutures
+        WX_DECLARE_LIST(MSG, wxMsgList);
 
-#if wxUSE_THREADS
-    #include "wx/thread.h"
+        #include "wx/listimpl.cpp"
 
-    // define the array of MSG strutures
-    WX_DECLARE_OBJARRAY(MSG, wxMsgArray);
+        WX_DEFINE_LIST(wxMsgList)
+    #endif // wxUSE_THREADS
+#endif //wxUSE_GUI
 
-    #include "wx/arrimpl.cpp"
+#if wxUSE_BASE
 
-    WX_DEFINE_OBJARRAY(wxMsgArray);
-#endif // wxUSE_THREADS
+// ============================================================================
+// wxMSWEventLoopBase implementation
+// ============================================================================
 
 // ----------------------------------------------------------------------------
-// wxEventLoopImpl
+// ctor/dtor
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxEventLoopImpl
+wxMSWEventLoopBase::wxMSWEventLoopBase()
 {
-public:
-    // ctor
-    wxEventLoopImpl() { m_exitcode = 0; m_shouldExit = false; }
-
-    // process a message
-    void ProcessMessage(MSG *msg);
+    m_shouldExit = false;
+    m_exitcode = 0;
+}
 
-    // generate an idle message, return TRUE if more idle time requested
-    bool SendIdleMessage();
+// ----------------------------------------------------------------------------
+// wxEventLoop message processing dispatching
+// ----------------------------------------------------------------------------
 
-    // set/get the exit code
-    void Exit(int exitcode) { m_exitcode = exitcode; m_shouldExit = true; }
-    int GetExitCode() const { return m_exitcode; }
-    bool ShouldExit() const { return m_shouldExit; }
+bool wxMSWEventLoopBase::Pending() const
+{
+    MSG msg;
+    return ::PeekMessage(&msg, 0, 0, 0, PM_NOREMOVE) != 0;
+}
 
-    enum wxCatchAllResponse {
-        catch_continue,
-        catch_exit,
-        catch_rethrow
-    };
-    wxCatchAllResponse OnCatchAll();
+bool wxMSWEventLoopBase::GetNextMessage(WXMSG* msg)
+{
+    wxCHECK_MSG( IsRunning(), false, _T("can't get messages if not running") );
 
-private:
-    // preprocess a message, return TRUE if processed (i.e. no further
-    // dispatching required)
-    bool PreProcessMessage(MSG *msg);
+    const BOOL rc = ::GetMessage(msg, NULL, 0, 0);
 
-    // the exit code of the event loop
-    int m_exitcode;
+    if ( rc == 0 )
+    {
+        // got WM_QUIT
+        return false;
+    }
 
-    // true if we were asked to terminate
-    bool m_shouldExit;
-};
+    if ( rc == -1 )
+    {
+        // should never happen, but let's test for it nevertheless
+        wxLogLastError(wxT("GetMessage"));
 
-// ----------------------------------------------------------------------------
-// helper class
-// ----------------------------------------------------------------------------
+        // still break from the loop
+        return false;
+    }
 
-wxDEFINE_TIED_SCOPED_PTR_TYPE(wxEventLoopImpl);
+    return true;
+}
 
-// this object sets the wxEventLoop given to the ctor as the currently active
-// one and unsets it in its dtor
-class wxEventLoopActivator
+int wxMSWEventLoopBase::GetNextMessageTimeout(WXMSG *msg, unsigned long timeout)
 {
-public:
-    wxEventLoopActivator(wxEventLoop **pActive,
-                         wxEventLoop *evtLoop)
+    // 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) )
     {
-        m_pActive = pActive;
-        m_evtLoopOld = *pActive;
-        *pActive = evtLoop;
+        // 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;
+        }
     }
 
-    ~wxEventLoopActivator()
-    {
-        // restore the previously active event loop
-        *m_pActive = m_evtLoopOld;
-    }
+    return msg->message != WM_QUIT;
+}
+
+
+#endif // wxUSE_BASE
 
-private:
-    wxEventLoop *m_evtLoopOld;
-    wxEventLoop **m_pActive;
-};
+#if wxUSE_GUI
 
 // ============================================================================
-// wxEventLoopImpl implementation
+// GUI wxEventLoop implementation
 // ============================================================================
 
-// ----------------------------------------------------------------------------
-// wxEventLoopImpl message processing
-// ----------------------------------------------------------------------------
+wxWindowMSW *wxGUIEventLoop::ms_winCritical = NULL;
 
-void wxEventLoopImpl::ProcessMessage(MSG *msg)
+bool wxGUIEventLoop::IsChildOfCriticalWindow(wxWindowMSW *win)
 {
-    // give us the chance to preprocess the message first
-    if ( !PreProcessMessage(msg) )
+    while ( win )
     {
-        // if it wasn't done, dispatch it to the corresponding window
-        ::TranslateMessage(msg);
-        ::DispatchMessage(msg);
+        if ( win == ms_winCritical )
+            return true;
+
+        win = win->GetParent();
     }
+
+    return false;
 }
 
-bool wxEventLoopImpl::PreProcessMessage(MSG *msg)
+bool wxGUIEventLoop::PreProcessMessage(WXMSG *msg)
 {
     HWND hwnd = msg->hwnd;
     wxWindow *wndThis = wxGetWindowFromHWND((WXHWND)hwnd);
+    wxWindow *wnd;
 
-    // this may happen if the event occured 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
+    // 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 )
     {
-        // we need to find the dialog containing this control as
-        // IsDialogMessage() just eats all the messages (i.e. returns TRUE for
-        // them) if we call it for the control itself
-        while ( hwnd && ::GetWindowLong(hwnd, GWL_STYLE) & WS_CHILD )
+        while ( hwnd && (::GetWindowLong(hwnd, GWL_STYLE) & WS_CHILD ))
         {
             hwnd = ::GetParent(hwnd);
+
+            // 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;
         }
 
-        return hwnd && ::IsDialogMessage(hwnd, msg) != 0;
+        if ( !wndThis )
+        {
+            // 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;
+        }
+    }
+
+    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 true;
     }
 
 #if wxUSE_TOOLTIPS
@@ -172,11 +216,10 @@ bool wxEventLoopImpl::PreProcessMessage(MSG *msg)
     // popup the tooltip bubbles
     if ( msg->message == WM_MOUSEMOVE )
     {
-        wxToolTip *tt = wndThis->GetToolTip();
-        if ( tt )
-        {
-            tt->RelayEvent((WXMSG *)msg);
-        }
+        // 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
 
@@ -185,16 +228,14 @@ bool wxEventLoopImpl::PreProcessMessage(MSG *msg)
     // grab Ctrl-C/V/X, even if they are also accelerators in some parent)
     if ( !wndThis->MSWShouldPreProcessMessage((WXMSG *)msg) )
     {
-        return FALSE;
+        return false;
     }
 
     // try translations first: the accelerators override everything
-    wxWindow *wnd;
-
     for ( wnd = wndThis; wnd; wnd = wnd->GetParent() )
     {
         if ( wnd->MSWTranslateMessage((WXMSG *)msg))
-            return TRUE;
+            return true;
 
         // 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
@@ -203,244 +244,173 @@ bool wxEventLoopImpl::PreProcessMessage(MSG *msg)
             break;
     }
 
-    // now try the other hooks (kbd navigation is handled here): we start from
-    // wndThis->GetParent() because wndThis->MSWProcessMessage() was already
-    // called above
-    for ( wnd = wndThis->GetParent(); wnd; wnd = wnd->GetParent() )
+    // now try the other hooks (kbd navigation is handled here)
+    for ( wnd = wndThis; wnd; wnd = wnd->GetParent() )
     {
         if ( wnd->MSWProcessMessage((WXMSG *)msg) )
-            return TRUE;
+            return true;
+
+        // 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;
     }
 
     // no special preprocessing for this message, dispatch it normally
-    return FALSE;
+    return false;
 }
 
-// ----------------------------------------------------------------------------
-// wxEventLoopImpl idle event processing
-// ----------------------------------------------------------------------------
-
-bool wxEventLoopImpl::SendIdleMessage()
+void wxGUIEventLoop::ProcessMessage(WXMSG *msg)
 {
-    return wxTheApp->ProcessIdle();
-}
-
-// ----------------------------------------------------------------------------
-// wxEventLoopImpl exception handling
-// ----------------------------------------------------------------------------
-
-wxEventLoopImpl::wxCatchAllResponse wxEventLoopImpl::OnCatchAll()
-{
-    switch (::MessageBox(NULL, 
-            _T("An unhandled exception occurred. 'Abort' will terminate the program,\r\n\
-'Retry' will close the current dialog, 'Ignore' will try to continue."),
-            _T("Unhandled exception"), 
-            MB_ABORTRETRYIGNORE|MB_ICONERROR|MB_TASKMODAL))
+    // give us the chance to preprocess the message first
+    if ( !PreProcessMessage(msg) )
     {
-        case IDABORT: return catch_rethrow;
-        case IDRETRY: return catch_exit;
-        case IDIGNORE: return catch_continue;
+        // if it wasn't done, dispatch it to the corresponding window
+        ::TranslateMessage(msg);
+        ::DispatchMessage(msg);
     }
-    return catch_rethrow;
 }
 
-// ============================================================================
-// wxEventLoop implementation
-// ============================================================================
+bool wxGUIEventLoop::Dispatch()
+{
+    MSG msg;
+    if ( !GetNextMessage(&msg) )
+        return false;
 
-wxEventLoop *wxEventLoop::ms_activeLoop = NULL;
+#if wxUSE_THREADS
+    wxASSERT_MSG( wxThread::IsMain(),
+                  wxT("only the main thread can process Windows messages") );
 
-// ----------------------------------------------------------------------------
-// wxEventLoop running and exiting
-// ----------------------------------------------------------------------------
+    static bool s_hadGuiLock = true;
+    static wxMsgList s_aSavedMessages;
 
-wxEventLoop::~wxEventLoop()
-{
-    wxASSERT_MSG( !m_impl, _T("should have been deleted in Run()") );
-}
+    // 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;
 
-bool wxEventLoop::IsRunning() const
-{
-    return m_impl != NULL;
-}
+        // leave out WM_COMMAND messages: too dangerous, sometimes
+        // the message will be processed twice
+        if ( !wxIsWaitingForThread() || msg.message != WM_COMMAND )
+        {
+            MSG* pMsg = new MSG(msg);
+            s_aSavedMessages.Append(pMsg);
+        }
 
-int wxEventLoop::Run()
-{
-    // event loops are not recursive, you need to create another loop!
-    wxCHECK_MSG( !IsRunning(), -1, _T("can't reenter a message loop") );
-
-    // SendIdleMessage() and Dispatch() below may throw so the code here should
-    // be exception-safe, hence we must use local objects for all actions we
-    // should undo
-    wxEventLoopActivator activate(&ms_activeLoop, this);
-    wxEventLoopImplTiedPtr impl(&m_impl, new wxEventLoopImpl);
-
-    // we must ensure that OnExit() is called even if an exception is thrown
-    // from inside Dispatch() but we must call it from Exit() in normal
-    // situations because it is supposed to be called synchronously,
-    // wxModalEventLoop depends on this (so we can't just use ON_BLOCK_EXIT or
-    // something similar here)
-#if wxUSE_EXCEPTIONS
-    bool retryAfterException;
-    do {
-        retryAfterException=false;
-#endif
-    wxTRY
+        return true;
+    }
+    else
     {
-        for ( ;; )
+        // have we just regained the GUI lock? if so, post all of the saved
+        // messages
+        //
+        // FIXME of course, it's not _exactly_ the same as processing the
+        //       messages normally - expect some things to break...
+        if ( !s_hadGuiLock )
         {
-    #if wxUSE_THREADS
-            wxMutexGuiLeaveOrEnter();
-    #endif // wxUSE_THREADS
-
-            // generate and process idle events for as long as we don't have
-            // anything else to do
-            while ( !Pending() && m_impl->SendIdleMessage() )
-                ;
+            s_hadGuiLock = true;
 
-            // if the "should exit" flag is set, the loop should terminate but
-            // not before processing any remaining messages so while Pending()
-            // returns true, do process them
-            if ( m_impl->ShouldExit() )
+            wxMsgList::compatibility_iterator node = s_aSavedMessages.GetFirst();
+            while (node)
             {
-                while ( Pending() )
-                    Dispatch();
+                MSG* pMsg = node->GetData();
+                s_aSavedMessages.Erase(node);
 
-                break;
-            }
+                ProcessMessage(pMsg);
+                delete pMsg;
 
-            // a message came or no more idle processing to do, sit in
-            // Dispatch() waiting for the next message
-            if ( !Dispatch() )
-            {
-                // we got WM_QUIT
-                break;
+                node = s_aSavedMessages.GetFirst();
             }
         }
-        }
-        wxCATCH_ALL( 
-            switch (m_impl->OnCatchAll()) {
-                case wxEventLoopImpl::catch_continue:
-                    retryAfterException=true;
-                    break;
-                case wxEventLoopImpl::catch_exit:
-                    OnExit();
-                    break;
-                case wxEventLoopImpl::catch_rethrow:
-                    OnExit();
-                    // should be replaced with wx macro, but
-                    // there is none yet. OTOH, wxCATCH_ALL isn't
-                    // expanded unless wxUSE_EXCEPTIONS, so its
-                    // safe to use throw here.
-                    throw;  
-                    break;
     }
-        )
-#if wxUSE_EXCEPTIONS
-    } while (retryAfterException);
-#endif
+#endif // wxUSE_THREADS
+
+    ProcessMessage(&msg);
 
-    return m_impl->GetExitCode();
+    return true;
 }
 
-void wxEventLoop::Exit(int rc)
+int wxGUIEventLoop::DispatchTimeout(unsigned long timeout)
 {
-    wxCHECK_RET( IsRunning(), _T("can't call Exit() if not running") );
-
-    m_impl->Exit(rc);
+    MSG msg;
+    int rc = GetNextMessageTimeout(&msg, timeout);
+    if ( rc != 1 )
+        return rc;
 
-    OnExit();
+    ProcessMessage(&msg);
 
-    // all we have to do to exit from the loop is to (maybe) wake it up so that
-    // it can notice that Exit() had been called
-    //
-    // in particular, we do *not* use PostQuitMessage() here because we're not
-    // sure that WM_QUIT is going to be processed by the correct event loop: it
-    // is possible that another one is started before this one has a chance to
-    // process WM_QUIT
-    ::PostMessage(NULL, WM_NULL, 0, 0);
+    return 1;
 }
 
-// ----------------------------------------------------------------------------
-// wxEventLoop message processing dispatching
-// ----------------------------------------------------------------------------
-
-bool wxEventLoop::Pending() const
+void wxGUIEventLoop::OnNextIteration()
 {
-    MSG msg;
-    return ::PeekMessage(&msg, 0, 0, 0, PM_NOREMOVE) != 0;
+#if wxUSE_THREADS
+    wxMutexGuiLeaveOrEnter();
+#endif // wxUSE_THREADS
 }
 
-bool wxEventLoop::Dispatch()
+void wxGUIEventLoop::WakeUp()
 {
-    wxCHECK_MSG( IsRunning(), FALSE, _T("can't call Dispatch() if not running") );
+    ::PostMessage(NULL, WM_NULL, 0, 0);
+}
 
-    MSG msg;
-    BOOL rc = ::GetMessage(&msg, (HWND) NULL, 0, 0);
+#else // !wxUSE_GUI
 
-    if ( rc == 0 )
-    {
-        // got WM_QUIT
-        return FALSE;
-    }
 
-    if ( rc == -1 )
-    {
-        // should never happen, but let's test for it nevertheless
-        wxLogLastError(wxT("GetMessage"));
+// ============================================================================
+// wxConsoleEventLoop implementation
+// ============================================================================
 
-        // still break from the loop
-        return FALSE;
-    }
+#if wxUSE_CONSOLE_EVENTLOOP
 
+void wxConsoleEventLoop::WakeUp()
+{
 #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;
+    wxWakeUpMainThread();
+#endif
+}
 
-    // 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() )
+void wxConsoleEventLoop::ProcessMessage(WXMSG *msg)
+{
+    if ( msg->message == WM_TIMER )
     {
-        s_hadGuiLock = FALSE;
-
-        // leave out WM_COMMAND messages: too dangerous, sometimes
-        // the message will be processed twice
-        if ( !wxIsWaitingForThread() || msg.message != WM_COMMAND )
-        {
-            s_aSavedMessages.Add(msg);
-        }
-
-        return TRUE;
+        TIMERPROC proc = (TIMERPROC)msg->lParam;
+        if ( proc )
+            (*proc)(NULL, 0, msg->wParam, 0);
     }
     else
     {
-        // have we just regained the GUI lock? if so, post all of the saved
-        // messages
-        //
-        // FIXME of course, it's not _exactly_ the same as processing the
-        //       messages normally - expect some things to break...
-        if ( !s_hadGuiLock )
-        {
-            s_hadGuiLock = TRUE;
+        ::DispatchMessage(msg);
+    }
+}
 
-            size_t count = s_aSavedMessages.Count();
-            for ( size_t n = 0; n < count; n++ )
-            {
-                MSG& msg = s_aSavedMessages[n];
-                m_impl->ProcessMessage(&msg);
-            }
+bool wxConsoleEventLoop::Dispatch()
+{
+    MSG msg;
+    if ( !GetNextMessage(&msg) )
+        return false;
 
-            s_aSavedMessages.Empty();
-        }
-    }
-#endif // wxUSE_THREADS
+    ProcessMessage(&msg);
 
-    m_impl->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 TRUE;
+    return !m_shouldExit;
 }
 
+#endif // wxUSE_CONSOLE_EVENTLOOP
+
+#endif //wxUSE_GUI