X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6d20f7ae50a3238d3846052bee83d47ba7ced735..a78d2fbab115b4c6537349fb06275d1610bf4aa0:/src/msw/timer.cpp?ds=sidebyside diff --git a/src/msw/timer.cpp b/src/msw/timer.cpp index 883f67bfa2..fae7e00d87 100644 --- a/src/msw/timer.cpp +++ b/src/msw/timer.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: msw/timer.cpp +// Name: src/msw/timer.cpp // Purpose: wxTimer implementation // Author: Julian Smart // Modified by: Vadim Zeitlin (use hash map instead of list, global rewrite) @@ -9,10 +9,6 @@ // 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,19 +18,18 @@ #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/timer.h" - #include "wx/msw/private.h" // ---------------------------------------------------------------------------- @@ -43,119 +38,207 @@ // 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, +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; + + 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 // ---------------------------------------------------------------------------- -// timer callback used for all timers -void WINAPI wxTimerProc(HWND hwnd, UINT msg, UINT idTimer, DWORD dwTime); +LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message, + WPARAM wParam, LPARAM lParam); + +// implemented in utils.cpp +extern "C" WXDLLIMPEXP_BASE HWND +wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc); + // ---------------------------------------------------------------------------- -// macros +// wxTimerHiddenWindowModule: used to manage the hidden window used for +// catching timer messages (we need a module to ensure that the window is +// always deleted) // ---------------------------------------------------------------------------- -IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxEvtHandler) +class wxTimerHiddenWindowModule : public wxModule +{ +public: + // module init/finalize + virtual bool OnInit(); + virtual void OnExit(); + + // get the hidden window (creates on demand) + static HWND GetHWND(); + +private: + // 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; -} - -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") ); + if ( !wxTimerImpl::Start(milliseconds, oneShot) ) + return false; - m_id = ::SetTimer + 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 ( - NULL, // don't use window - 1, // id ignored with NULL hwnd anyhow - (UINT)m_milli, // delay - wxTimerProc // timer proc to call + wxTimerHiddenWindowModule::GetHWND(), // window for WM_TIMER + m_id, // timer ID to create + (UINT)m_milli, // delay + NULL // timer proc (unused) ); - if ( !m_id ) + 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 - if ( g_timerMap.find(m_id) != g_timerMap.end() ) - { - wxLogError(_("Timer creation failed.")); + return true; +} - ::KillTimer(NULL, m_id); - m_id = 0; +void wxMSWTimerImpl::Stop() +{ + ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id); + TimerMap().erase(m_id); + m_id = 0; +} - return false; - } +// ---------------------------------------------------------------------------- +// private functions +// ---------------------------------------------------------------------------- - g_timerMap[m_id] = this; +void wxProcessTimer(wxMSWTimerImpl& timer) +{ + wxASSERT_MSG( timer.IsRunning(), wxT("bogus timer id") ); - return true; + if ( timer.IsOneShot() ) + timer.Stop(); + + timer.Notify(); } -void wxTimer::Stop() + +LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message, + WPARAM wParam, LPARAM lParam) { - if ( m_id ) + if ( message == WM_TIMER ) { - ::KillTimer(NULL, m_id); + wxTimerMap::iterator node = TimerMap().find(wParam); - g_timerMap.erase(m_id); + if ( node != TimerMap().end() ) + { + wxProcessTimer(*(node->second)); + + return 0; + } + //else: Unknown timer, probably one of our timers that had fired just + // before being removed from the timers map by Stop(). } - m_id = 0; + return ::DefWindowProc(hWnd, message, wParam, lParam); } // ---------------------------------------------------------------------------- -// private functions +// wxTimerHiddenWindowModule functions // ---------------------------------------------------------------------------- -void wxProcessTimer(wxTimer& timer) -{ - wxASSERT_MSG( timer.m_id != 0, _T("bogus timer id") ); - if ( timer.IsOneShot() ) - timer.Stop(); +HWND wxTimerHiddenWindowModule::ms_hwnd = NULL; - timer.Notify(); +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 WINAPI -wxTimerProc(HWND WXUNUSED(hwnd), - UINT WXUNUSED(msg), - UINT idTimer, - DWORD WXUNUSED(dwTime)) +void wxTimerHiddenWindowModule::OnExit() { - wxTimerMap::iterator node = g_timerMap.find(idTimer); + if ( ms_hwnd ) + { + if ( !::DestroyWindow(ms_hwnd) ) + { + wxLogLastError(wxT("DestroyWindow(wxTimerHiddenWindow)")); + } - wxCHECK_RET( node != g_timerMap.end(), wxT("bogus timer id in wxTimerProc") ); + ms_hwnd = NULL; + } - wxProcessTimer(*(node->second)); + if ( ms_className ) + { + if ( !::UnregisterClass(ms_className, wxGetInstance()) ) + { + wxLogLastError(wxT("UnregisterClass(\"wxTimerHiddenWindow\")")); + } + + ms_className = NULL; + } } -#endif // wxUSE_TIMER +/* 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