X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c2ca375c5620209d77a88d2d378bdcdedbc82e7e..ba49d2acf95d53517719c4fd9ac2ad5aaa13540b:/src/msw/timer.cpp

diff --git a/src/msw/timer.cpp b/src/msw/timer.cpp
index 9027958705..21f40cfb03 100644
--- a/src/msw/timer.cpp
+++ b/src/msw/timer.cpp
@@ -27,9 +27,11 @@
     #include "wx/intl.h"
     #include "wx/log.h"
     #include "wx/hashmap.h"
+    #include "wx/module.h"
 #endif
 
 #include "wx/msw/private.h"
+#include "wx/msw/private/hiddenwin.h"
 
 // ----------------------------------------------------------------------------
 // private globals
@@ -37,7 +39,7 @@
 
 // define a hash containing all the timers: it is indexed by timer id and
 // contains the corresponding timer
-WX_DECLARE_HASH_MAP(unsigned long, wxMSWTimerImpl *, wxIntegerHash, wxIntegerEqual,
+WX_DECLARE_HASH_MAP(WPARAM, wxMSWTimerImpl *, wxIntegerHash, wxIntegerEqual,
                     wxTimerMap);
 
 // instead of using a global here, wrap it in a static function as otherwise it
@@ -50,17 +52,64 @@ static wxTimerMap& TimerMap()
     return s_timerMap;
 }
 
+// This gets a unique, non-zero timer ID and creates an entry in the TimerMap
+UINT_PTR GetNewTimerId(wxMSWTimerImpl *t)
+{
+    static UINT_PTR lastTimerId = 0;
+
+    while (lastTimerId == 0 ||
+            TimerMap().find(lastTimerId) != TimerMap().end())
+    {
+        lastTimerId = lastTimerId + 1;
+    }
+
+    TimerMap()[lastTimerId] = t;
+
+    return lastTimerId;
+}
+
+
+
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
 
-// timer callback used for all timers
-void WINAPI wxTimerProc(HWND hwnd, UINT msg, UINT_PTR idTimer, DWORD dwTime);
+LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
+                                        WPARAM wParam, LPARAM lParam);
+
+// ----------------------------------------------------------------------------
+// wxTimerHiddenWindowModule: used to manage the hidden window used for
+// catching timer messages (we need a module to ensure that the window is
+// always deleted)
+// ----------------------------------------------------------------------------
+
+class wxTimerHiddenWindowModule : public wxModule
+{
+public:
+    // module init/finalize
+    virtual bool OnInit();
+    virtual void OnExit();
+
+    // get the hidden window (creates on demand)
+    static HWND GetHWND();
+
+private:
+    // the HWND of the hidden window
+    static HWND ms_hwnd;
+
+    // the class used to create it
+    static const wxChar *ms_className;
+
+    DECLARE_DYNAMIC_CLASS(wxTimerHiddenWindowModule)
+};
+
+IMPLEMENT_DYNAMIC_CLASS(wxTimerHiddenWindowModule, wxModule)
 
 // ============================================================================
 // implementation
 // ============================================================================
 
+
 // ----------------------------------------------------------------------------
 // wxMSWTimerImpl class
 // ----------------------------------------------------------------------------
@@ -70,47 +119,31 @@ bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot)
     if ( !wxTimerImpl::Start(milliseconds, oneShot) )
         return false;
 
-    m_id = ::SetTimer
+    m_id = GetNewTimerId(this);
+    // SetTimer() normally returns just idTimer but this might change in the
+    // future so use its return value to be safe
+    UINT_PTR ret = ::SetTimer
              (
-                NULL,                       // don't use window
-                1,                          // id ignored with NULL hwnd anyhow
-                (UINT)m_milli,              // delay
-                wxTimerProc                 // timer proc to call
+              wxTimerHiddenWindowModule::GetHWND(),  // window for WM_TIMER
+              m_id,                                  // timer ID to create
+              (UINT)m_milli,                         // delay
+              NULL                                   // timer proc (unused)
              );
 
-    if ( !m_id )
+    if ( ret == 0 )
     {
         wxLogSysError(_("Couldn't create a timer"));
 
         return false;
     }
 
-    // check that SetTimer() didn't reuse an existing id: according to the MSDN
-    // this can happen and this would be catastrophic to us as we rely on ids
-    // uniquely identifying the timers because we use them as keys in the hash
-    if ( TimerMap().find(m_id) != TimerMap().end() )
-    {
-        wxLogError(_("Timer creation failed."));
-
-        ::KillTimer(NULL, m_id);
-        m_id = 0;
-
-        return false;
-    }
-
-    TimerMap()[m_id] = this;
-
     return true;
 }
 
 void wxMSWTimerImpl::Stop()
 {
-    wxASSERT_MSG( m_id, _T("should be running") );
-
-    ::KillTimer(NULL, m_id);
-
+    ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id);
     TimerMap().erase(m_id);
-
     m_id = 0;
 }
 
@@ -120,7 +153,7 @@ void wxMSWTimerImpl::Stop()
 
 void wxProcessTimer(wxMSWTimerImpl& timer)
 {
-    wxASSERT_MSG( timer.IsRunning(), _T("bogus timer id") );
+    wxASSERT_MSG( timer.IsRunning(), wxT("bogus timer id") );
 
     if ( timer.IsOneShot() )
         timer.Stop();
@@ -128,17 +161,80 @@ void wxProcessTimer(wxMSWTimerImpl& timer)
     timer.Notify();
 }
 
-void WINAPI
-wxTimerProc(HWND WXUNUSED(hwnd),
-            UINT WXUNUSED(msg),
-            UINT_PTR idTimer,
-            DWORD WXUNUSED(dwTime))
+
+LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
+                                        WPARAM wParam, LPARAM lParam)
+{
+    if ( message == WM_TIMER )
+    {
+        wxTimerMap::iterator node = TimerMap().find(wParam);
+
+        if ( node != TimerMap().end() )
+        {
+            wxProcessTimer(*(node->second));
+
+            return 0;
+        }
+        //else: Unknown timer, probably one of our timers that had fired just
+        //      before being removed from the timers map by Stop().
+    }
+
+    return ::DefWindowProc(hWnd, message, wParam, lParam);
+}
+
+// ----------------------------------------------------------------------------
+// wxTimerHiddenWindowModule functions
+// ----------------------------------------------------------------------------
+
+
+HWND wxTimerHiddenWindowModule::ms_hwnd = NULL;
+
+const wxChar *wxTimerHiddenWindowModule::ms_className = NULL;
+
+bool wxTimerHiddenWindowModule::OnInit()
 {
-    wxTimerMap::iterator node = TimerMap().find((unsigned long)idTimer);
+    // do not initialize ms_hwnd to ms_className to NULL here: it may happen
+    // that our GetHWND() is called before the modules are initialized if a
+    // timer is created from wxApp-derived class ctor and in this case we
+    // shouldn't overwrite it
 
-    wxCHECK_RET( node != TimerMap().end(), wxT("bogus timer id in wxTimerProc") );
+    return true;
+}
+
+void wxTimerHiddenWindowModule::OnExit()
+{
+    if ( ms_hwnd )
+    {
+        if ( !::DestroyWindow(ms_hwnd) )
+        {
+            wxLogLastError(wxT("DestroyWindow(wxTimerHiddenWindow)"));
+        }
+
+        ms_hwnd = NULL;
+    }
+
+    if ( ms_className )
+    {
+        if ( !::UnregisterClass(ms_className, wxGetInstance()) )
+        {
+            wxLogLastError(wxT("UnregisterClass(\"wxTimerHiddenWindow\")"));
+        }
+
+        ms_className = NULL;
+    }
+}
+
+/* static */
+HWND wxTimerHiddenWindowModule::GetHWND()
+{
+    static const wxChar *HIDDEN_WINDOW_CLASS = wxT("wxTimerHiddenWindow");
+    if ( !ms_hwnd )
+    {
+        ms_hwnd = wxCreateHiddenWindow(&ms_className, HIDDEN_WINDOW_CLASS,
+                                     wxTimerWndProc);
+    }
 
-    wxProcessTimer(*(node->second));
+    return ms_hwnd;
 }
 
 #endif // wxUSE_TIMER