X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5b6c8794de19b49b0248b49c7fb7bf8a682ba38d..e75390d4aa51b46b9217dc4699267c1345893054:/src/msw/timer.cpp diff --git a/src/msw/timer.cpp b/src/msw/timer.cpp index c58cb7cc0a..0db65998b1 100644 --- a/src/msw/timer.cpp +++ b/src/msw/timer.cpp @@ -1,18 +1,14 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: msw/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" @@ -22,205 +18,137 @@ #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" + #include "wx/module.h" #endif -#include "wx/hashmap.h" -#include "wx/module.h" - -#include "wx/timer.h" - #include "wx/msw/private.h" -// from utils.cpp -extern "C" HWND -wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc); - // ---------------------------------------------------------------------------- -// private functions +// private globals // ---------------------------------------------------------------------------- -// define a hash containing all the timers: it is indexed by HWND and timer id -struct wxTimerKey -{ - wxTimerKey(WXHWND hwnd, int id) : m_hwnd(hwnd), m_id(id) { } - wxTimerKey(HWND hwnd, int id) : m_hwnd((WXHWND)hwnd), m_id(id) { } - - WXHWND m_hwnd; - int m_id; -}; - -static inline bool operator==(const wxTimerKey& tk1, const wxTimerKey& tk2) -{ - return tk1.m_hwnd == tk2.m_hwnd && tk1.m_id == tk2.m_id; -} - -struct wxTimerKeyHash -{ - wxTimerKeyHash() { } - unsigned long operator()(const wxTimerKey& tk) const - { return (unsigned long)tk.m_hwnd + tk.m_id; } - - wxTimerKeyHash& operator=(const wxTimerKeyHash&) { return *this; } -}; - -struct wxTimerKeyEqual -{ - wxTimerKeyEqual() { } - bool operator()(const wxTimerKey& tk1, const wxTimerKey& tk2) const - { return tk1 == tk2; } - - wxTimerKeyEqual& operator=(const wxTimerKeyEqual&) { return *this; } -}; - -WX_DECLARE_HASH_MAP(wxTimerKey, wxTimer *, wxTimerKeyHash, wxTimerKeyEqual, +// define a hash containing all the timers: it is indexed by timer id and +// contains the corresponding timer +WX_DECLARE_HASH_MAP(WPARAM, wxMSWTimerImpl *, wxIntegerHash, wxIntegerEqual, wxTimerMap); -static wxTimerMap g_timerMap; +// 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 // ---------------------------------------------------------------------------- -IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject) +LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message, + WPARAM wParam, LPARAM lParam); -// ---------------------------------------------------------------------------- -// globals -// ---------------------------------------------------------------------------- +// implemented in utils.cpp +extern "C" WXDLLIMPEXP_BASE HWND +wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc); -// these variables are for timer shared hwnd management -static const wxChar *wxMSWTIMER_WNDCLASSNAME = wxT("_wxTimer_Internal_Class"); -static LPCTSTR s_classnameTimerWnd = NULL; -static HWND s_hwndTimer = NULL; // ---------------------------------------------------------------------------- -// private classes +// wxTimerHiddenWindowModule: used to manage the hidden window used for +// catching timer messages (we need a module to ensure that the window is +// always deleted) // ---------------------------------------------------------------------------- -class wxTimerModule : public wxModule +class wxTimerHiddenWindowModule : public wxModule { public: - virtual bool OnInit() { return true; } - virtual void OnExit() - { - if ( s_hwndTimer ) - { - ::DestroyWindow(s_hwndTimer); - s_hwndTimer = NULL; + // module init/finalize + virtual bool OnInit(); + virtual void OnExit(); - if ( !::UnregisterClass(wxMSWTIMER_WNDCLASSNAME, wxGetInstance()) ) - { - wxLogLastError(_T("UnregisterClass(wxTimerClass)")); - } - - s_classnameTimerWnd = NULL; - } - } + // get the hidden window (creates on demand) + static HWND GetHWND(); private: - DECLARE_DYNAMIC_CLASS(wxTimerModule) + // the HWND of the hidden window + static HWND ms_hwnd; + + // the class used to create it + static const wxChar *ms_className; + + DECLARE_DYNAMIC_CLASS(wxTimerHiddenWindowModule) }; +IMPLEMENT_DYNAMIC_CLASS(wxTimerHiddenWindowModule, wxModule) + // ============================================================================ // implementation // ============================================================================ + // ---------------------------------------------------------------------------- -// wxTimer class +// wxMSWTimerImpl class // ---------------------------------------------------------------------------- -void wxTimer::Init() +bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot) { - m_id = 0; - m_hwnd = NULL; -} - -wxTimer::~wxTimer() -{ - wxTimer::Stop(); -} - -bool wxTimer::Start(int milliseconds, bool oneShot) -{ - (void)wxTimerBase::Start(milliseconds, oneShot); - - wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeour") ); - - // find a window for SetTimer(): it should be a valid HWND owned by this - // thread (even if we had a non NULL m_hwnd before, reset it in case the - // owner has changed) - m_hwnd = NULL; + if ( !wxTimerImpl::Start(milliseconds, oneShot) ) + return false; - // first try the owner window - if ( m_owner ) - { - wxWindow *win = wxDynamicCast(m_owner, wxWindow); - if ( win ) - { - m_hwnd = win->GetHWND(); - } - } + 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 not, use a shared hidden window - if ( !m_hwnd ) + if ( !m_id ) { - if ( !s_hwndTimer ) - { - s_hwndTimer = wxCreateHiddenWindow - ( - &s_classnameTimerWnd, - wxMSWTIMER_WNDCLASSNAME, - ::DefWindowProc - ); - - if ( !s_hwndTimer ) - { - wxASSERT_MSG( s_hwndTimer, wxT("can't create a HWND for wxTimer") ); - return false; - } - } - - m_hwnd = (WXHWND)s_hwndTimer; + wxLogSysError(_("Couldn't create a timer")); + return false; } - m_id = ::SetTimer - ( - (HWND)m_hwnd, - (UINT)(m_id ? m_id : 1), - (UINT)m_milli, - (TIMERPROC)wxTimerProc - ); - - if ( !m_id ) + // 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() ) { - wxLogSysError(_("Couldn't create a timer")); + wxLogError(_("Timer creation failed.")); + + ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id); + m_id = 0; return false; } - g_timerMap[wxTimerKey(m_hwnd, m_id)] = this; + TimerMap()[m_id] = this; return true; } -void wxTimer::Stop() +void wxMSWTimerImpl::Stop() { - if ( m_id ) - { - ::KillTimer((HWND)m_hwnd, (UINT)m_id); - m_hwnd = NULL; + wxASSERT_MSG( m_id, wxT("should be running") ); - g_timerMap.erase(wxTimerKey(m_hwnd, m_id)); - } + ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id); + + TimerMap().erase(m_id); m_id = 0; } @@ -229,9 +157,9 @@ void wxTimer::Stop() // private functions // ---------------------------------------------------------------------------- -void wxProcessTimer(wxTimer& timer) +void wxProcessTimer(wxMSWTimerImpl& timer) { - wxASSERT_MSG( timer.m_id != 0, _T("bogus timer id") ); + wxASSERT_MSG( timer.IsRunning(), wxT("bogus timer id") ); if ( timer.IsOneShot() ) timer.Stop(); @@ -239,14 +167,78 @@ void wxProcessTimer(wxTimer& timer) timer.Notify(); } -void WINAPI wxTimerProc(HWND hwnd, WORD, int idTimer, DWORD) + +LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message, + WPARAM wParam, LPARAM lParam) { - wxTimerMap::iterator node = g_timerMap.find(wxTimerKey(hwnd, idTimer)); + if ( message == WM_TIMER ) + { + wxTimerMap::iterator node = TimerMap().find(wParam); - wxCHECK_RET( node != g_timerMap.end(), wxT("bogus timer id in wxTimerProc") ); + wxCHECK_MSG( node != TimerMap().end(), 0, wxT("bogus timer id in wxTimerProc") ); - wxProcessTimer(*(node->second)); + wxProcessTimer(*(node->second)); + } + else + { + return ::DefWindowProc(hWnd, message, wParam, lParam); + } + return 0; } -#endif // wxUSE_TIMER +// ---------------------------------------------------------------------------- +// wxTimerHiddenWindowModule functions +// ---------------------------------------------------------------------------- + +HWND wxTimerHiddenWindowModule::ms_hwnd = NULL; + +const wxChar *wxTimerHiddenWindowModule::ms_className = NULL; + +bool wxTimerHiddenWindowModule::OnInit() +{ + // do not initialize ms_hwnd to ms_className to NULL here: it may happen + // that our GetHWND() is called before the modules are initialized if a + // timer is created from wxApp-derived class ctor and in this case we + // shouldn't overwrite it + + return true; +} + +void wxTimerHiddenWindowModule::OnExit() +{ + if ( ms_hwnd ) + { + if ( !::DestroyWindow(ms_hwnd) ) + { + wxLogLastError(wxT("DestroyWindow(wxTimerHiddenWindow)")); + } + + ms_hwnd = NULL; + } + + if ( ms_className ) + { + if ( !::UnregisterClass(ms_className, wxGetInstance()) ) + { + wxLogLastError(wxT("UnregisterClass(\"wxTimerHiddenWindow\")")); + } + + ms_className = NULL; + } +} + +/* static */ +HWND wxTimerHiddenWindowModule::GetHWND() +{ + static const wxChar *HIDDEN_WINDOW_CLASS = wxT("wxTimerHiddenWindow"); + if ( !ms_hwnd ) + { + ms_hwnd = wxCreateHiddenWindow(&ms_className, HIDDEN_WINDOW_CLASS, + wxTimerWndProc); + } + + return ms_hwnd; +} + +#endif // wxUSE_TIMER