]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/timer.cpp
don't compare invalid iterators/node pointers
[wxWidgets.git] / src / msw / timer.cpp
index 09f830cd951728a0142a4b346399c2f787358e9c..d93588c63728250d12f608a2219b2b9ee37d379e 100644 (file)
@@ -2,17 +2,13 @@
 // Name:        msw/timer.cpp
 // Purpose:     wxTimer implementation
 // Author:      Julian Smart
-// Modified by:
+// Modified by: Vadim Zeitlin (use hash map instead of list, global rewrite)
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "timer.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #endif
 
 #include "wx/hashmap.h"
-#include "wx/module.h"
 
 #include "wx/timer.h"
 
 #include "wx/msw/private.h"
 
-// from utils.cpp
-extern "C" HWND
-wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
-
 // ----------------------------------------------------------------------------
-// private functions
+// private globals
 // ----------------------------------------------------------------------------
 
-WX_DECLARE_HASH_MAP( long,
-                     wxTimer *,
-                     wxIntegerHash,
-                     wxIntegerEqual,
-                     wxTimerMap );
-
-wxTimerMap wxTimerList;
+// define a hash containing all the timers: it is indexed by timer id and
+// contains the corresponding timer
+WX_DECLARE_HASH_MAP(unsigned long, wxTimer *, wxIntegerHash, wxIntegerEqual,
+                    wxTimerMap);
 
-void WINAPI wxTimerProc(HWND hwnd, WORD, int idTimer, DWORD);
-
-// ----------------------------------------------------------------------------
-// macros
-// ----------------------------------------------------------------------------
+// instead of using a global here, wrap it in a static function as otherwise it
+// could have been used before being initialized if a timer object were created
+// globally
+static wxTimerMap& TimerMap()
+{
+    static wxTimerMap s_timerMap;
 
-IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject)
+    return s_timerMap;
+}
 
 // ----------------------------------------------------------------------------
-// globals
+// private functions
 // ----------------------------------------------------------------------------
 
-// these variables are for timer shared hwnd management
-static const wxChar *wxMSWTIMER_WNDCLASSNAME = wxT("_wxTimer_Internal_Class");
-static LPCTSTR s_classnameTimerWnd = NULL;
-static HWND s_hwndTimer = NULL;
+// timer callback used for all timers
+void WINAPI wxTimerProc(HWND hwnd, UINT msg, UINT_PTR idTimer, DWORD dwTime);
 
 // ----------------------------------------------------------------------------
-// private classes
+// macros
 // ----------------------------------------------------------------------------
 
-class wxTimerModule : public wxModule
-{
-public:
-    virtual bool OnInit() { return true; }
-    virtual void OnExit()
-    {
-        if ( s_hwndTimer )
-        {
-            ::DestroyWindow(s_hwndTimer);
-            s_hwndTimer = NULL;
-
-            if ( !::UnregisterClass(wxMSWTIMER_WNDCLASSNAME, wxGetInstance()) )
-            {
-                wxLogLastError(_T("UnregisterClass(wxTimerClass)"));
-            }
-
-            s_classnameTimerWnd = NULL;
-        }
-    }
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxTimerModule)
-};
+IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxEvtHandler)
 
 // ============================================================================
 // implementation
@@ -110,69 +76,25 @@ private:
 void wxTimer::Init()
 {
     m_id = 0;
-    m_hwnd = NULL;
 }
 
 wxTimer::~wxTimer()
 {
-    // save id as Stop() changes it
-    long id = m_id;
-
     wxTimer::Stop();
-
-    wxTimerList.erase(id);
 }
 
 bool wxTimer::Start(int milliseconds, bool oneShot)
 {
-    wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeour") );
-
     (void)wxTimerBase::Start(milliseconds, oneShot);
 
-    // find a window for SetTimer(): it should be a valid HWND owned by this
-    // thread (even if we had a non NULL m_hwnd before, reset it in case the
-    // owner has changed)
-    m_hwnd = NULL;
-
-    // first try the owner window
-    if ( m_owner )
-    {
-        wxWindow *win = wxDynamicCast(m_owner, wxWindow);
-        if ( win )
-        {
-            m_hwnd = win->GetHWND();
-        }
-    }
-
-    // if not, use a shared hidden window
-    if ( !m_hwnd )
-    {
-        if ( !s_hwndTimer )
-        {
-            s_hwndTimer = wxCreateHiddenWindow
-                          (
-                            &s_classnameTimerWnd,
-                            wxMSWTIMER_WNDCLASSNAME,
-                            ::DefWindowProc
-                          );
-
-            if ( !s_hwndTimer )
-            {
-                wxASSERT_MSG( s_hwndTimer, wxT("can't create a HWND for wxTimer") );
-                return false;
-            }
-        }
-
-        m_hwnd = (WXHWND)s_hwndTimer;
-
-    }
+    wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeout") );
 
     m_id = ::SetTimer
              (
-                (HWND)m_hwnd,
-                (UINT)(m_id ? m_id : 1),
-                (UINT)m_milli,
-                (TIMERPROC)wxTimerProc
+                NULL,                       // don't use window
+                1,                          // id ignored with NULL hwnd anyhow
+                (UINT)m_milli,              // delay
+                wxTimerProc                 // timer proc to call
              );
 
     if ( !m_id )
@@ -182,7 +104,20 @@ bool wxTimer::Start(int milliseconds, bool oneShot)
         return false;
     }
 
-    wxTimerList[m_id] = this;
+    // 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;
 }
@@ -191,10 +126,9 @@ void wxTimer::Stop()
 {
     if ( m_id )
     {
-        ::KillTimer((HWND)m_hwnd, (UINT)m_id);
-        m_hwnd = NULL;
+        ::KillTimer(NULL, m_id);
 
-        wxTimerList.erase(m_id);
+        TimerMap().erase(m_id);
     }
 
     m_id = 0;
@@ -206,9 +140,7 @@ void wxTimer::Stop()
 
 void wxProcessTimer(wxTimer& timer)
 {
-    // Avoid to process spurious timer events
-    if ( timer.m_id == 0)
-        return;
+    wxASSERT_MSG( timer.m_id != 0, _T("bogus timer id") );
 
     if ( timer.IsOneShot() )
         timer.Stop();
@@ -216,11 +148,15 @@ void wxProcessTimer(wxTimer& timer)
     timer.Notify();
 }
 
-void WINAPI wxTimerProc(HWND WXUNUSED(hwnd), WORD, int idTimer, DWORD)
+void WINAPI
+wxTimerProc(HWND WXUNUSED(hwnd),
+            UINT WXUNUSED(msg),
+            UINT_PTR idTimer,
+            DWORD WXUNUSED(dwTime))
 {
-    wxTimerMap::iterator node = wxTimerList.find((long)idTimer);
+    wxTimerMap::iterator node = TimerMap().find((unsigned long)idTimer);
 
-    wxASSERT_MSG( node != wxTimerList.end(), wxT("bogus timer id in wxTimerProc") );
+    wxCHECK_RET( node != TimerMap().end(), wxT("bogus timer id in wxTimerProc") );
 
     wxProcessTimer(*(node->second));
 }