cleanup - reformat - 4th pass

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

diff --git a/src/msw/timer.cpp b/src/msw/timer.cpp
index 3781b06f2b040e765fdb84c258eaa59c6196d847..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
 // 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
 /////////////////////////////////////////////////////////////////////////////
 
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // 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"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -38,35 +34,36 @@
 #include "wx/msw/private.h"
 
 // ----------------------------------------------------------------------------
 #include "wx/msw/private.h"
 
 // ----------------------------------------------------------------------------

-// private functions
+// private globals

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-WX_DECLARE_HASH_MAP( long,
-                     wxTimer *,
-                     wxIntegerHash,
-                     wxIntegerEqual,
-                     wxTimerMap );
+// 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);

 
 

-wxTimerMap wxTimerList;
+// 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;

 
 

-void WINAPI _EXPORT wxTimerProc(HWND hwnd, WORD, int idTimer, DWORD);
+    return s_timerMap;
+}

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// macros
+// private functions

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-#ifdef __WIN32__
-    #define _EXPORT
-#else
-    #define _EXPORT _export
-#endif
+// timer callback used for all timers
+void WINAPI wxTimerProc(HWND hwnd, UINT msg, UINT_PTR idTimer, DWORD dwTime);

 
 

-// should probably be in wx/msw/private.h
-#ifdef __WXMICROWIN__
-    #define MakeProcInstance(proc, hinst) proc
-#endif
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------

 
 

-IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject)
+IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxEvtHandler)

 
 // ============================================================================
 // implementation
 
 // ============================================================================
 // implementation


@@ -83,51 +80,55 @@ void wxTimer::Init()
 
 wxTimer::~wxTimer()
 {
 
 wxTimer::~wxTimer()
 {

-    long id = m_id;
-

     wxTimer::Stop();
     wxTimer::Stop();

-
-    wxTimerList.erase(id);

 }
 
 bool wxTimer::Start(int milliseconds, bool oneShot)
 {
     (void)wxTimerBase::Start(milliseconds, oneShot);
 
 }
 
 bool wxTimer::Start(int milliseconds, bool oneShot)
 {
     (void)wxTimerBase::Start(milliseconds, oneShot);
 

-    wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeour") );
-
-#ifdef __WXWINCE__
-    m_id = ::SetTimer(NULL, (UINT)(m_id ? m_id : 1),
-                      (UINT)m_milli, (void (__stdcall *)(struct HWND__ *,unsigned int,unsigned int,unsigned long)) wxTimerProc);
-#else
-    TIMERPROC wxTimerProcInst = (TIMERPROC)
-        MakeProcInstance((FARPROC)wxTimerProc, wxGetInstance());
+    wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeout") );

 
 

-    m_id = ::SetTimer(NULL, (UINT)(m_id ? m_id : 1),
-                      (UINT)m_milli, wxTimerProcInst);
-#endif
+    m_id = ::SetTimer
+             (
+                NULL,                       // don't use window
+                1,                          // id ignored with NULL hwnd anyhow
+                (UINT)m_milli,              // delay
+                wxTimerProc                 // timer proc to call
+             );

 
 

-    if ( m_id > 0 )
+    if ( !m_id )

     {
     {

-        wxTimerList[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 )
     {
 }
 
 void wxTimer::Stop()
 {
     if ( m_id )
     {

-        ::KillTimer(NULL, (UINT)m_id);
+        ::KillTimer(NULL, m_id);

 
 

-        wxTimerList.erase(m_id);
+        TimerMap().erase(m_id);

     }
 
     m_id = 0;
     }
 
     m_id = 0;


@@ -139,9 +140,7 @@ void wxTimer::Stop()
 
 void wxProcessTimer(wxTimer& timer)
 {
 
 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();
 
     if ( timer.IsOneShot() )
         timer.Stop();


@@ -149,16 +148,18 @@ void wxProcessTimer(wxTimer& timer)
     timer.Notify();
 }
 
     timer.Notify();
 }
 

-void 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))

 {
 {

-    
-    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));
 
     wxProcessTimer(*(node->second));

-
-    // return 0;

 }
 
 #endif // wxUSE_TIMER
 }
 
 #endif // wxUSE_TIMER

+