src/msw/evtloop.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/evtloop.cpp
   3 // Purpose:     implements wxEventLoop for MSW
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     01.06.01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // License:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  21     #pragma implementation "evtloop.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/window.h"
  33     #include "wx/app.h"
  34 #endif //WX_PRECOMP
  35
  36 #include "wx/evtloop.h"
  37 #include "wx/tooltip.h"
  38
  39 #include "wx/msw/private.h"
  40
  41 #if wxUSE_THREADS
  42     // define the array of MSG strutures
  43     WX_DECLARE_OBJARRAY(MSG, wxMsgArray);
  44     // VS: this is a bit dirty - it duplicates same declaration in app.cpp
  45     //     (and there's no WX_DEFINE_OBJARRAY for that reason - it is already
  46     //     defined in app.cpp).
  47 #endif
  48
  49 // ----------------------------------------------------------------------------
  50 // wxEventLoopImpl
  51 // ----------------------------------------------------------------------------
  52
  53 class WXDLLEXPORT wxEventLoopImpl
  54 {
  55 public:
  56     // ctor
  57     wxEventLoopImpl() { SetExitCode(0); }
  58
  59     // process a message
  60     void ProcessMessage(MSG *msg);
  61
  62     // generate an idle message, return TRUE if more idle time requested
  63     bool SendIdleMessage();
  64
  65     // set/get the exit code
  66     void SetExitCode(int exitcode) { m_exitcode = exitcode; }
  67     int GetExitCode() const { return m_exitcode; }
  68
  69 private:
  70     // preprocess a message, return TRUE if processed (i.e. no further
  71     // dispatching required)
  72     bool PreProcessMessage(MSG *msg);
  73
  74     // the exit code of the event loop
  75     int m_exitcode;
  76 };
  77
  78 // ============================================================================
  79 // wxEventLoopImpl implementation
  80 // ============================================================================
  81
  82 // ----------------------------------------------------------------------------
  83 // wxEventLoopImpl message processing
  84 // ----------------------------------------------------------------------------
  85
  86 void wxEventLoopImpl::ProcessMessage(MSG *msg)
  87 {
  88     // give us the chance to preprocess the message first
  89     if ( !PreProcessMessage(msg) )
  90     {
  91         // if it wasn't done, dispatch it to the corresponding window
  92         ::TranslateMessage(msg);
  93         ::DispatchMessage(msg);
  94     }
  95 }
  96
  97 bool wxEventLoopImpl::PreProcessMessage(MSG *msg)
  98 {
  99     HWND hWnd = msg->hwnd;
 100     wxWindow *wndThis = wxGetWindowFromHWND((WXHWND)hWnd);
 101
 102 #if wxUSE_TOOLTIPS
 103     // we must relay WM_MOUSEMOVE events to the tooltip ctrl if we want it to
 104     // popup the tooltip bubbles
 105     if ( wndThis && (msg->message == WM_MOUSEMOVE) )
 106     {
 107         wxToolTip *tt = wndThis->GetToolTip();
 108         if ( tt )
 109         {
 110             tt->RelayEvent((WXMSG *)msg);
 111         }
 112     }
 113 #endif // wxUSE_TOOLTIPS
 114
 115     // try translations first; find the youngest window with a translation
 116     // table.
 117     wxWindow *wnd;
 118     for ( wnd = wndThis; wnd; wnd = wnd->GetParent() )
 119     {
 120         if ( wnd->MSWTranslateMessage((WXMSG *)msg) )
 121             return TRUE;
 122     }
 123
 124     // Anyone for a non-translation message? Try youngest descendants first.
 125     for ( wnd = wndThis; wnd; wnd = wnd->GetParent() )
 126     {
 127         if ( wnd->MSWProcessMessage((WXMSG *)msg) )
 128             return TRUE;
 129     }
 130
 131     return FALSE;
 132 }
 133
 134 // ----------------------------------------------------------------------------
 135 // wxEventLoopImpl idle event processing
 136 // ----------------------------------------------------------------------------
 137
 138 bool wxEventLoopImpl::SendIdleMessage()
 139 {
 140     return wxTheApp->ProcessIdle();
 141 }
 142
 143 // ============================================================================
 144 // wxEventLoop implementation
 145 // ============================================================================
 146
 147 wxEventLoop *wxEventLoop::ms_activeLoop = NULL;
 148
 149 // ----------------------------------------------------------------------------
 150 // wxEventLoop running and exiting
 151 // ----------------------------------------------------------------------------
 152
 153 wxEventLoop::~wxEventLoop()
 154 {
 155     wxASSERT_MSG( !m_impl, _T("should have been deleted in Run()") );
 156 }
 157
 158 bool wxEventLoop::IsRunning() const
 159 {
 160     return m_impl != NULL;
 161 }
 162
 163 int wxEventLoop::Run()
 164 {
 165     // event loops are not recursive, you need to create another loop!
 166     wxCHECK_MSG( !IsRunning(), -1, _T("can't reenter a message loop") );
 167
 168     m_impl = new wxEventLoopImpl;
 169
 170     wxEventLoop *oldLoop = ms_activeLoop;
 171     ms_activeLoop = this;
 172
 173     for ( ;; )
 174     {
 175 #if wxUSE_THREADS
 176         wxMutexGuiLeaveOrEnter();
 177 #endif // wxUSE_THREADS
 178
 179         // generate and process idle events for as long as we don't have
 180         // anything else to do
 181         while ( !Pending() && m_impl->SendIdleMessage() )
 182             ;
 183
 184         // a message came or no more idle processing to do, sit in Dispatch()
 185         // waiting for the next message
 186         if ( !Dispatch() )
 187         {
 188             // we got WM_QUIT
 189             break;
 190         }
 191     }
 192
 193     int exitcode = m_impl->GetExitCode();
 194     delete m_impl;
 195     m_impl = NULL;
 196
 197     ms_activeLoop = oldLoop;
 198
 199     return exitcode;
 200 }
 201
 202 void wxEventLoop::Exit(int rc)
 203 {
 204     wxCHECK_RET( IsRunning(), _T("can't call Exit() if not running") );
 205
 206     m_impl->SetExitCode(rc);
 207
 208     ::PostQuitMessage(rc);
 209 }
 210
 211 // ----------------------------------------------------------------------------
 212 // wxEventLoop message processing dispatching
 213 // ----------------------------------------------------------------------------
 214
 215 bool wxEventLoop::Pending() const
 216 {
 217     MSG msg;
 218     return ::PeekMessage(&msg, 0, 0, 0, PM_NOREMOVE) != 0;
 219 }
 220
 221 bool wxEventLoop::Dispatch()
 222 {
 223     wxCHECK_MSG( IsRunning(), FALSE, _T("can't call Dispatch() if not running") );
 224
 225     MSG msg;
 226     BOOL rc = ::GetMessage(&msg, (HWND) NULL, 0, 0);
 227
 228     if ( rc == 0 )
 229     {
 230         // got WM_QUIT
 231         return FALSE;
 232     }
 233
 234     if ( rc == -1 )
 235     {
 236         // should never happen, but let's test for it nevertheless
 237         wxLogLastError(wxT("GetMessage"));
 238
 239         // still break from the loop
 240         return FALSE;
 241     }
 242
 243 #if wxUSE_THREADS
 244     wxASSERT_MSG( wxThread::IsMain(),
 245                   wxT("only the main thread can process Windows messages") );
 246
 247     static bool s_hadGuiLock = TRUE;
 248     static wxMsgArray s_aSavedMessages;
 249
 250     // if a secondary thread owning the mutex is doing GUI calls, save all
 251     // messages for later processing - we can't process them right now because
 252     // it will lead to recursive library calls (and we're not reentrant)
 253     if ( !wxGuiOwnedByMainThread() )
 254     {
 255         s_hadGuiLock = FALSE;
 256
 257         // leave out WM_COMMAND messages: too dangerous, sometimes
 258         // the message will be processed twice
 259         if ( !wxIsWaitingForThread() || msg.message != WM_COMMAND )
 260         {
 261             s_aSavedMessages.Add(msg);
 262         }
 263
 264         return TRUE;
 265     }
 266     else
 267     {
 268         // have we just regained the GUI lock? if so, post all of the saved
 269         // messages
 270         //
 271         // FIXME of course, it's not _exactly_ the same as processing the
 272         //       messages normally - expect some things to break...
 273         if ( !s_hadGuiLock )
 274         {
 275             s_hadGuiLock = TRUE;
 276
 277             size_t count = s_aSavedMessages.Count();
 278             for ( size_t n = 0; n < count; n++ )
 279             {
 280                 MSG& msg = s_aSavedMessages[n];
 281                 m_impl->ProcessMessage(&msg);
 282             }
 283
 284             s_aSavedMessages.Empty();
 285         }
 286     }
 287 #endif // wxUSE_THREADS
 288
 289     m_impl->ProcessMessage(&msg);
 290
 291     return TRUE;
 292 }
 293