/////////////////////////////////////////////////////////////////////////////
-// Name: timer.cpp
+// Name: src/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"
#if wxUSE_TIMER
+#include "wx/msw/private/timer.h"
+
#ifndef WX_PRECOMP
- #include "wx/window.h"
#include "wx/list.h"
#include "wx/event.h"
#include "wx/app.h"
#include "wx/intl.h"
#include "wx/log.h"
+ #include "wx/hashmap.h"
#endif
-#include "wx/hashmap.h"
-
-#include "wx/timer.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, wxMSWTimerImpl *, 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 wxTimerProc(HWND hwnd, WORD, int idTimer, DWORD);
+ return s_timerMap;
+}
// ----------------------------------------------------------------------------
-// macros
+// private functions
// ----------------------------------------------------------------------------
-// should probably be in wx/msw/missing.h
-#ifdef __WXMICROWIN__
- #define MakeProcInstance(proc, hinst) proc
-#endif
-
-IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject)
+// timer callback used for all timers
+void WINAPI wxTimerProc(HWND hwnd, UINT msg, UINT_PTR idTimer, DWORD dwTime);
// ============================================================================
// implementation
// ============================================================================
// ----------------------------------------------------------------------------
-// wxTimer class
+// wxMSWTimerImpl class
// ----------------------------------------------------------------------------
-void wxTimer::Init()
+bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot)
{
- m_id = 0;
-}
-
-wxTimer::~wxTimer()
-{
- long id = m_id;
-
- wxTimer::Stop();
-
- wxTimerList.erase(id);
-}
-
-bool wxTimer::Start(int milliseconds, bool oneShot)
-{
- (void)wxTimerBase::Start(milliseconds, oneShot);
-
- wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeour") );
+ if ( !wxTimerImpl::Start(milliseconds, oneShot) )
+ return false;
-#ifdef __WXWINCE__
- m_id = ::SetTimer(NULL, (UINT)(m_id ? m_id : 1),
- (UINT)m_milli, (TIMERPROC) wxTimerProc);
-#else
- 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)m_milli, wxTimerProcInst);
-#endif
-
- 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;
}
+
+ TimerMap()[m_id] = this;
+
+ return true;
}
-void wxTimer::Stop()
+void wxMSWTimerImpl::Stop()
{
- if ( m_id )
- {
- ::KillTimer(NULL, (UINT)m_id);
+ wxASSERT_MSG( m_id, _T("should be running") );
- wxTimerList.erase(m_id);
- }
+ ::KillTimer(NULL, m_id);
+
+ TimerMap().erase(m_id);
m_id = 0;
}
// private functions
// ----------------------------------------------------------------------------
-void wxProcessTimer(wxTimer& timer)
+void wxProcessTimer(wxMSWTimerImpl& timer)
{
- // Avoid to process spurious timer events
- if ( timer.m_id == 0)
- return;
+ wxASSERT_MSG( timer.IsRunning(), _T("bogus timer id") );
if ( timer.IsOneShot() )
timer.Stop();
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));
}
#endif // wxUSE_TIMER
-