Remove some out of date comments.

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

diff --git a/src/msw/timer.cpp b/src/msw/timer.cpp
index 48d24f04d0a2cf24f385ce5d77523188585dd76d..fae7e00d87c712b541b601db363c7214413e310f 100644 (file)
--- a/src/msw/timer.cpp
+++ b/src/msw/timer.cpp
@@ -38,7 +38,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
@@ -51,6 +51,24 @@ 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
 // ----------------------------------------------------------------------------
@@ -105,51 +123,31 @@ bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot)
     if ( !wxTimerImpl::Start(milliseconds, oneShot) )
         return false;
 
-    m_id = ::SetTimer(
-        wxTimerHiddenWindowModule::GetHWND(),  // window to send the messages to
-        GetId(),                               // timer ID
-        (UINT)m_milli,                         // delay
-        NULL                                   // timer proc.  Not used since we pass hwnd
-        );
-
-    if ( !m_id )
+    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
+             (
+              wxTimerHiddenWindowModule::GetHWND(),  // window for WM_TIMER
+              m_id,                                  // timer ID to create
+              (UINT)m_milli,                         // delay
+              NULL                                   // timer proc (unused)
+             );
+
+    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
-    //
-    // notice that this also happens if the same id is reused for multiple
-    // timers: this used to work in previous versions but was never supported
-    // and absolutely shouldn't be done, use wxID_ANY to assign an id to the
-    // timer automatically or ensure that all your timers have unique ids
-    if ( TimerMap().find(m_id) != TimerMap().end() )
-    {
-        wxLogError(_("Timer creation failed."));
-
-        ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), 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(wxTimerHiddenWindowModule::GetHWND(), m_id);
-
     TimerMap().erase(m_id);
-
     m_id = 0;
 }
 
@@ -159,7 +157,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();
@@ -173,17 +171,19 @@ LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
 {
     if ( message == WM_TIMER )
     {
-        wxTimerMap::iterator node = TimerMap().find((unsigned long)wParam);
+        wxTimerMap::iterator node = TimerMap().find(wParam);
 
-        wxCHECK_MSG( node != TimerMap().end(), 0, wxT("bogus timer id in wxTimerProc") );
+        if ( node != TimerMap().end() )
+        {
+            wxProcessTimer(*(node->second));
 
-        wxProcessTimer(*(node->second));
-    }
-    else
-    {
-        return ::DefWindowProc(hWnd, message, wParam, lParam);
+            return 0;
+        }
+        //else: Unknown timer, probably one of our timers that had fired just
+        //      before being removed from the timers map by Stop().
     }
-    return 0;
+
+    return ::DefWindowProc(hWnd, message, wParam, lParam);
 }
 
 // ----------------------------------------------------------------------------
@@ -211,7 +211,7 @@ void wxTimerHiddenWindowModule::OnExit()
     {
         if ( !::DestroyWindow(ms_hwnd) )
         {
-            wxLogLastError(_T("DestroyWindow(wxTimerHiddenWindow)"));
+            wxLogLastError(wxT("DestroyWindow(wxTimerHiddenWindow)"));
         }
 
         ms_hwnd = NULL;
@@ -221,7 +221,7 @@ void wxTimerHiddenWindowModule::OnExit()
     {
         if ( !::UnregisterClass(ms_className, wxGetInstance()) )
         {
-            wxLogLastError(_T("UnregisterClass(\"wxTimerHiddenWindow\")"));
+            wxLogLastError(wxT("UnregisterClass(\"wxTimerHiddenWindow\")"));
         }
 
         ms_className = NULL;
@@ -231,7 +231,7 @@ void wxTimerHiddenWindowModule::OnExit()
 /* static */
 HWND wxTimerHiddenWindowModule::GetHWND()
 {
-    static const wxChar *HIDDEN_WINDOW_CLASS = _T("wxTimerHiddenWindow");
+    static const wxChar *HIDDEN_WINDOW_CLASS = wxT("wxTimerHiddenWindow");
     if ( !ms_hwnd )
     {
         ms_hwnd = wxCreateHiddenWindow(&ms_className, HIDDEN_WINDOW_CLASS,