don't compare invalid iterators/node pointers

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

diff --git a/src/msw/timer.cpp b/src/msw/timer.cpp
index 7d994c99384b5e8eccd4ffdb5db4d1b240a42a86..d93588c63728250d12f608a2219b2b9ee37d379e 100644 (file)
--- a/src/msw/timer.cpp
+++ b/src/msw/timer.cpp
@@ -1,18 +1,14 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        timer.cpp
+// 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 and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-    #pragma implementation "timer.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
@@ -20,8 +16,9 @@
     #pragma hdrstop
 #endif
 
+#if wxUSE_TIMER
+
 #ifndef WX_PRECOMP
-    #include "wx/setup.h"
     #include "wx/window.h"
     #include "wx/list.h"
     #include "wx/event.h"
@@ -30,28 +27,43 @@
     #include "wx/log.h"
 #endif
 
+#include "wx/hashmap.h"
+
 #include "wx/timer.h"
 
 #include "wx/msw/private.h"
 
+// ----------------------------------------------------------------------------
+// private globals
+// ----------------------------------------------------------------------------
+
+// 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);
+
+// 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;
+
+    return s_timerMap;
+}
+
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
 
-wxList wxTimerList(wxKEY_INTEGER);
-UINT WINAPI _EXPORT wxTimerProc(HWND hwnd, WORD, int idTimer, DWORD);
+// timer callback used for all timers
+void WINAPI wxTimerProc(HWND hwnd, UINT msg, UINT_PTR idTimer, DWORD dwTime);
 
 // ----------------------------------------------------------------------------
 // macros
 // ----------------------------------------------------------------------------
 
-#ifdef __WIN32__
-    #define _EXPORT
-#else
-    #define _EXPORT _export
-#endif
-
-IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject)
+IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxEvtHandler)
 
 // ============================================================================
 // implementation
@@ -69,42 +81,54 @@ void wxTimer::Init()
 wxTimer::~wxTimer()
 {
     wxTimer::Stop();
-
-    wxTimerList.DeleteObject(this);
 }
 
 bool wxTimer::Start(int milliseconds, bool oneShot)
 {
     (void)wxTimerBase::Start(milliseconds, oneShot);
 
-    wxCHECK_MSG( m_milli > 0, FALSE, wxT("invalid value for timer timeour") );
+    wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeout") );
 
-    wxTimerList.DeleteObject(this);
-    TIMERPROC wxTimerProcInst = (TIMERPROC)
-        MakeProcInstance((FARPROC)wxTimerProc, wxGetInstance());
+    m_id = ::SetTimer
+             (
+                NULL,                       // don't use window
+                1,                          // id ignored with NULL hwnd anyhow
+                (UINT)m_milli,              // delay
+                wxTimerProc                 // timer proc to call
+             );
 
-    m_id = SetTimer(NULL, (UINT)(m_id ? m_id : 1),
-                    (UINT)milliseconds, wxTimerProcInst);
-    if ( m_id > 0 )
+    if ( !m_id )
     {
-        wxTimerList.Append(m_id, this);
+        wxLogSysError(_("Couldn't create a timer"));
 
-        return TRUE;
+        return false;
     }
-    else
+
+    // 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() )
     {
-        wxLogSysError(_("Couldn't create a timer"));
+        wxLogError(_("Timer creation failed."));
+
+        ::KillTimer(NULL, m_id);
+        m_id = 0;
 
-        return FALSE;
+        return false;
     }
+
+    TimerMap()[m_id] = this;
+
+    return true;
 }
 
 void wxTimer::Stop()
 {
     if ( m_id )
     {
-        KillTimer(NULL, (UINT)m_id);
-        wxTimerList.DeleteObject(this);
+        ::KillTimer(NULL, m_id);
+
+        TimerMap().erase(m_id);
     }
 
     m_id = 0;
@@ -116,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();
@@ -126,13 +148,18 @@ void wxProcessTimer(wxTimer& timer)
     timer.Notify();
 }
 
-UINT WINAPI _EXPORT wxTimerProc(HWND WXUNUSED(hwnd), WORD, int idTimer, DWORD)
+void WINAPI
+wxTimerProc(HWND WXUNUSED(hwnd),
+            UINT WXUNUSED(msg),
+            UINT_PTR idTimer,
+            DWORD WXUNUSED(dwTime))
 {
-    wxNode *node = wxTimerList.Find((long)idTimer);
+    wxTimerMap::iterator node = TimerMap().find((unsigned long)idTimer);
 
-    wxCHECK_MSG( node, 0, wxT("bogus timer id in wxTimerProc") );
+    wxCHECK_RET( node != TimerMap().end(), wxT("bogus timer id in wxTimerProc") );
 
-    wxProcessTimer(*(wxTimer *)node->Data());
-
-    return 0;
+    wxProcessTimer(*(node->second));
 }
+
+#endif // wxUSE_TIMER
+