X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a3b466481eac25cbef1d35aaf6ee9d94167a07b9..2c755d9bbf4c786a03cf6193c630fc986a69f802:/src/msw/timer.cpp diff --git a/src/msw/timer.cpp b/src/msw/timer.cpp index 5a6e1cf939..725a5f133f 100644 --- a/src/msw/timer.cpp +++ b/src/msw/timer.cpp @@ -1,18 +1,14 @@ ///////////////////////////////////////////////////////////////////////////// -// 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 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" @@ -20,129 +16,239 @@ #pragma hdrstop #endif +#if wxUSE_TIMER + +#include "wx/msw/private/timer.h" + #ifndef WX_PRECOMP - #include "wx/setup.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/intl.h" -#include "wx/log.h" - -#include "wx/timer.h" #include "wx/msw/private.h" -#include -#include +// ---------------------------------------------------------------------------- +// private globals +// ---------------------------------------------------------------------------- -#if !defined(__SC__) && !defined(__GNUWIN32__) - #include -#endif +// 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); + +// 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; +} // ---------------------------------------------------------------------------- // private functions // ---------------------------------------------------------------------------- -wxList wxTimerList(wxKEY_INTEGER); -UINT WINAPI _EXPORT wxTimerProc(HWND hwnd, WORD, int idTimer, DWORD); +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) // ---------------------------------------------------------------------------- -#ifdef __WIN32__ - #define _EXPORT /**/ -#else - #define _EXPORT _export -#endif +class wxTimerHiddenWindowModule : public wxModule +{ +public: + // module init/finalize + virtual bool OnInit(); + virtual void OnExit(); -#if !USE_SHARED_LIBRARY - IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject) -#endif + // 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 // ---------------------------------------------------------------------------- -wxTimer::wxTimer(void) + +bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot) { - milli = 0 ; - lastMilli = -1 ; - id = 0; + if ( !wxTimerImpl::Start(milliseconds, oneShot) ) + return false; + + // SetTimer() doesn't accept 0 timer id so use something else if the timer + // id at wx level is 0: as -1 (wxID_ANY) can't be used, we can safely + // replace 0 with it at MSW level + UINT idTimer = GetId(); + if ( !idTimer ) + idTimer = (UINT)-1; + + // SetTimer() normally returns just idTimer but this might change in the + // future so use its return value to be safe + m_id = ::SetTimer + ( + wxTimerHiddenWindowModule::GetHWND(), // window for WM_TIMER + idTimer, // timer ID to create + (UINT)m_milli, // delay + NULL // timer proc (unused) + ); + + 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 + // + // 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() ) + { + wxLogError(_("Timer creation failed.")); + + ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id); + m_id = 0; + + return false; + } + + TimerMap()[m_id] = this; + + return true; } -wxTimer::~wxTimer(void) +void wxMSWTimerImpl::Stop() { - Stop(); + wxASSERT_MSG( m_id, wxT("should be running") ); + + ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id); + + TimerMap().erase(m_id); - wxTimerList.DeleteObject(this); + m_id = 0; } -bool wxTimer::Start(int milliseconds, bool mode) +// ---------------------------------------------------------------------------- +// private functions +// ---------------------------------------------------------------------------- + +void wxProcessTimer(wxMSWTimerImpl& timer) { - oneShot = mode ; - if (milliseconds < 0) - milliseconds = lastMilli; + wxASSERT_MSG( timer.IsRunning(), wxT("bogus timer id") ); - wxCHECK_MSG( milliseconds > 0, FALSE, "invalid value for timer timeour" ); + if ( timer.IsOneShot() ) + timer.Stop(); - lastMilli = milli = milliseconds; + timer.Notify(); +} - wxTimerList.DeleteObject(this); - TIMERPROC wxTimerProcInst = (TIMERPROC) - MakeProcInstance((FARPROC)wxTimerProc, wxGetInstance()); - id = SetTimer(NULL, (UINT)(id ? id : 1), - (UINT)milliseconds, wxTimerProcInst); - if (id > 0) +LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message, + WPARAM wParam, LPARAM lParam) +{ + if ( message == WM_TIMER ) { - wxTimerList.Append(id, this); + wxTimerMap::iterator node = TimerMap().find(wParam); + + wxCHECK_MSG( node != TimerMap().end(), 0, wxT("bogus timer id in wxTimerProc") ); - return TRUE; + wxProcessTimer(*(node->second)); } else { - wxLogSysError(_("Couldn't create a timer")); - - return FALSE; + return ::DefWindowProc(hWnd, message, wParam, lParam); } -} - -void wxTimer::Stop(void) -{ - if (id) { - KillTimer(NULL, (UINT)id); - wxTimerList.DeleteObject(this); /* @@@@ */ - } - id = 0 ; - milli = 0 ; + return 0; } // ---------------------------------------------------------------------------- -// private functions +// wxTimerHiddenWindowModule functions // ---------------------------------------------------------------------------- -static void wxProcessTimer(wxTimer& timer) -{ - // Avoid to process spurious timer events - if ( timer.id == 0) - return; - if ( timer.oneShot ) - timer.Stop(); - timer.Notify(); +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; } -UINT WINAPI _EXPORT wxTimerProc(HWND WXUNUSED(hwnd), WORD, int idTimer, DWORD) +void wxTimerHiddenWindowModule::OnExit() { - wxNode *node = wxTimerList.Find((long)idTimer); + if ( ms_hwnd ) + { + if ( !::DestroyWindow(ms_hwnd) ) + { + wxLogLastError(wxT("DestroyWindow(wxTimerHiddenWindow)")); + } + + ms_hwnd = NULL; + } - wxCHECK_MSG( node, 0, "bogus timer id in wxTimerProc" ); + if ( ms_className ) + { + if ( !::UnregisterClass(ms_className, wxGetInstance()) ) + { + wxLogLastError(wxT("UnregisterClass(\"wxTimerHiddenWindow\")")); + } - wxProcessTimer(*(wxTimer *)node->Data()); + ms_className = NULL; + } +} - return 0; +/* 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