cleanup - reformat - 4th pass

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

diff --git a/src/msw/timer.cpp b/src/msw/timer.cpp
index 99cd51d92a116289d66b197d5e55a76dfb4f2dd6..d93588c63728250d12f608a2219b2b9ee37d379e 100644 (file)
--- a/src/msw/timer.cpp
+++ b/src/msw/timer.cpp
@@ -1,113 +1,165 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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$
 // 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"
 
 #ifdef __BORLANDC__
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

+#if wxUSE_TIMER
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-#include "wx/setup.h"
-#include "wx/list.h"
-#include "wx/app.h"
+    #include "wx/window.h"
+    #include "wx/list.h"
+    #include "wx/event.h"
+    #include "wx/app.h"
+    #include "wx/intl.h"
+    #include "wx/log.h"

 #endif
 
 #endif
 

+#include "wx/hashmap.h"
+

 #include "wx/timer.h"
 #include "wx/timer.h"

+

 #include "wx/msw/private.h"
 
 #include "wx/msw/private.h"
 

-#include <time.h>
-#include <sys/types.h>
+// ----------------------------------------------------------------------------
+// private globals
+// ----------------------------------------------------------------------------

 
 

-#if !defined(__SC__) && !defined(__GNUWIN32__)
-#include <sys/timeb.h>
-#endif
-#ifdef __WIN32__
-#define _EXPORT /**/
-#else
-#define _EXPORT _export
-#endif
+// 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);

 
 

-wxList wxTimerList(wxKEY_INTEGER);
-UINT WINAPI _EXPORT wxTimerProc(HWND hwnd, WORD, int idTimer, DWORD);
+// 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;

 
 

-#if !USE_SHARED_LIBRARY
-IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject)
-#endif
+    return s_timerMap;
+}
+
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+// timer callback used for all timers
+void WINAPI wxTimerProc(HWND hwnd, UINT msg, UINT_PTR idTimer, DWORD dwTime);
+
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------
+
+IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxEvtHandler)

 
 

-wxTimer::wxTimer(void)
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxTimer class
+// ----------------------------------------------------------------------------
+
+void wxTimer::Init()

 {
 {

-  milli = 0 ;
-  lastMilli = -1 ;
-  id = 0;
+    m_id = 0;

 }
 
 }
 

-wxTimer::~wxTimer(void)
+wxTimer::~wxTimer()

 {
 {

-  Stop();
+    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 timeout") );
+
+    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 )
+    {
+        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;

 }
 
 }
 

-bool wxTimer::Start(int milliseconds,bool mode)
+void wxTimer::Stop()

 {
 {

-  oneShot = mode ;
-  if (milliseconds < 0)
-    milliseconds = lastMilli;
-
-  if (milliseconds <= 0)
-    return FALSE;
-
-  lastMilli = milli = milliseconds;
-
-  wxTimerList.DeleteObject(this);
-  TIMERPROC wxTimerProcInst = (TIMERPROC) MakeProcInstance((FARPROC)wxTimerProc,
-                                          wxGetInstance());
-
-  id = SetTimer(NULL, (UINT)(id ? id : 1), (UINT)milliseconds, wxTimerProcInst);
-  if (id > 0)
-  {
-    wxTimerList.Append(id, this);
-    return TRUE;
-  }
-  else return FALSE;
+    if ( m_id )
+    {
+        ::KillTimer(NULL, m_id);
+
+        TimerMap().erase(m_id);
+    }
+
+    m_id = 0;

 }
 
 }
 

-void wxTimer::Stop(void)
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+void wxProcessTimer(wxTimer& timer)

 {
 {

-  if (id) {
-    KillTimer(NULL, (UINT)id);
-    wxTimerList.DeleteObject(this); /* @@@@ */
-  }
-  id = 0 ;
-  milli = 0 ;
+    wxASSERT_MSG( timer.m_id != 0, _T("bogus timer id") );
+
+    if ( timer.IsOneShot() )
+        timer.Stop();
+
+    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);
-  if (node)
-  {
-    wxTimer *timer = (wxTimer *)node->Data();
-    if (timer->id==0)
-      return(0) ; // Avoid to process spurious timer events
-    if (timer->oneShot)
-      timer->Stop() ;
-    timer->Notify();
-  }
-  return 0;
+    wxTimerMap::iterator node = TimerMap().find((unsigned long)idTimer);
+
+    wxCHECK_RET( node != TimerMap().end(), wxT("bogus timer id in wxTimerProc") );
+
+    wxProcessTimer(*(node->second));

 }
 
 }
 

+#endif // wxUSE_TIMER
+