X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/de85a884d77ad5a29b418b343d4d3cc99c127b5e..beb2638a997914bd12c55e81589adebd90af9ed2:/src/common/timercmn.cpp diff --git a/src/common/timercmn.cpp b/src/common/timercmn.cpp index 3ff1adf9d1..defa3b9dd4 100644 --- a/src/common/timercmn.cpp +++ b/src/common/timercmn.cpp @@ -1,17 +1,13 @@ ///////////////////////////////////////////////////////////////////////////// // Name: common/timercmn.cpp -// Purpose: Common timer implementation -// Author: -// Original version by Julian Smart -// Vadim Zeitlin got rid of all ifdefs (11.12.99) -// Sylvain Bougnoux added wxStopWatch class -// Guillermo Rodriguez rewrote from scratch (Dic/99) -// Modified by: +// Purpose: wxTimerBase implementation +// Author: Julian Smart, Guillermo Rodriguez, Vadim Zeitlin +// Modified by: VZ: extracted all non-wxTimer stuff in stopwatch.cpp (20.06.03) // Created: 04/01/98 // RCS-ID: $Id$ -// Copyright: (c) Julian Smart and Markus Holzem +// Copyright: (c) Julian Smart // (c) 1999 Guillermo Rodriguez -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -22,10 +18,6 @@ // wxWin headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "timerbase.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -33,321 +25,115 @@ #pragma hdrstop #endif +#if wxUSE_TIMER + #ifndef WX_PRECOMP - #include "wx/intl.h" - #include "wx/log.h" + #include "wx/app.h" #endif #include "wx/timer.h" -#include "wx/longlong.h" - -// ---------------------------------------------------------------------------- -// System headers -// ---------------------------------------------------------------------------- - -#if defined(__WIN32__) - #include -#endif - -#if defined(__WIN32__) && !defined(HAVE_FTIME) - #define HAVE_FTIME -#endif - -#if defined(__VISAGECPP__) && !defined(HAVE_FTIME) - #define HAVE_FTIME -# if __IBMCPP__ >= 400 - # define ftime(x) _ftime(x) -# endif -#endif - -#if defined(__MWERKS__) && defined(__WXMSW__) -# undef HAVE_FTIME -# undef HAVE_GETTIMEOFDAY -#endif - -#include -#ifndef __WXMAC__ - #include // for time_t -#endif - -#if defined(HAVE_GETTIMEOFDAY) - #include - #include -#elif defined(HAVE_FTIME) - #include -#endif +#include "wx/apptrait.h" +#include "wx/private/timer.h" // ---------------------------------------------------------------------------- // wxWin macros // ---------------------------------------------------------------------------- -#if wxUSE_GUI && wxUSE_TIMER - IMPLEMENT_DYNAMIC_CLASS(wxTimerEvent, wxEvent) -#endif // wxUSE_GUI +IMPLEMENT_DYNAMIC_CLASS(wxTimerEvent, wxEvent) -// ---------------------------------------------------------------------------- -// macros -// ---------------------------------------------------------------------------- - -// on some really old systems gettimeofday() doesn't have the second argument, -// define wxGetTimeOfDay() to hide this difference -#ifdef HAVE_GETTIMEOFDAY - #ifdef WX_GETTIMEOFDAY_NO_TZ - struct timezone; - #define wxGetTimeOfDay(tv, tz) gettimeofday(tv) - #else - #define wxGetTimeOfDay(tv, tz) gettimeofday((tv), (tz)) - #endif -#endif // HAVE_GETTIMEOFDAY +wxDEFINE_EVENT(wxEVT_TIMER, wxTimerEvent); // ============================================================================ -// implementation +// wxTimerBase implementation // ============================================================================ -// ---------------------------------------------------------------------------- -// wxTimerBase -// ---------------------------------------------------------------------------- - -#if wxUSE_GUI && wxUSE_TIMER - -void wxTimerBase::Notify() +wxTimer::~wxTimer() { - // the base class version generates an event if it has owner - which it - // should because otherwise nobody can process timer events - wxCHECK_RET( m_owner, _T("wxTimer::Notify() should be overridden.") ); + Stop(); - wxTimerEvent event(m_idTimer, m_milli); - (void)m_owner->ProcessEvent(event); + delete m_impl; } -bool wxTimerBase::Start(int milliseconds, bool oneShot) +void wxTimer::Init() { - if ( IsRunning() ) + wxAppTraits * const traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + m_impl = traits ? traits->CreateTimerImpl(this) : NULL; + if ( !m_impl ) { - // not stopping the already running timer might work for some - // platforms (no problems under MSW) but leads to mysterious crashes - // on the others (GTK), so to be on the safe side do it here - Stop(); - } + wxFAIL_MSG( _T("No timer implementation for this platform") ); - if ( milliseconds != -1 ) - { - m_milli = milliseconds; } - - m_oneShot = oneShot; - - return TRUE; } -#endif // wxUSE_GUI - -// ---------------------------------------------------------------------------- -// wxStopWatch -// ---------------------------------------------------------------------------- - -#if wxUSE_LONGLONG +// ============================================================================ +// rest of wxTimer implementation forwarded to wxTimerImpl +// ============================================================================ -void wxStopWatch::Start(long t) +void wxTimer::SetOwner(wxEvtHandler *owner, int timerid) { - m_t0 = wxGetLocalTimeMillis() - t; - m_pause = 0; -} + wxCHECK_RET( m_impl, _T("uninitialized timer") ); -long wxStopWatch::GetElapsedTime() const -{ - return (wxGetLocalTimeMillis() - m_t0).GetLo(); + m_impl->SetOwner(owner, timerid); } -long wxStopWatch::Time() const +wxEvtHandler *wxTimer::GetOwner() const { - return (m_pause ? m_pause : GetElapsedTime()); -} - -#endif // wxUSE_LONGLONG + wxCHECK_MSG( m_impl, NULL, _T("uninitialized timer") ); -// ---------------------------------------------------------------------------- -// old timer functions superceded by wxStopWatch -// ---------------------------------------------------------------------------- - -#if wxUSE_LONGLONG - -static wxLongLong wxStartTime = 0l; + return m_impl->GetOwner(); +} -// starts the global timer -void wxStartTimer() +bool wxTimer::Start(int milliseconds, bool oneShot) { - wxStartTime = wxGetLocalTimeMillis(); + wxCHECK_MSG( m_impl, false, _T("uninitialized timer") ); + + return m_impl->Start(milliseconds, oneShot); } -// Returns elapsed time in milliseconds -long wxGetElapsedTime(bool resetTimer) +void wxTimer::Stop() { - wxLongLong oldTime = wxStartTime; - wxLongLong newTime = wxGetLocalTimeMillis(); + wxCHECK_RET( m_impl, _T("uninitialized timer") ); - if ( resetTimer ) - wxStartTime = newTime; - - return (newTime - oldTime).GetLo(); + if ( m_impl->IsRunning() ) + m_impl->Stop(); } -#endif // wxUSE_LONGLONG +void wxTimer::Notify() +{ + // the base class version generates an event if it has owner - which it + // should because otherwise nobody can process timer events + wxCHECK_RET( GetOwner(), _T("wxTimer::Notify() should be overridden.") ); -// ---------------------------------------------------------------------------- -// the functions to get the current time and timezone info -// ---------------------------------------------------------------------------- + m_impl->SendEvent(); +} -// Get local time as seconds since 00:00:00, Jan 1st 1970 -long wxGetLocalTime() +bool wxTimer::IsRunning() const { - struct tm tm; - time_t t0, t1; - - // This cannot be made static because mktime can overwrite it. - // - memset(&tm, 0, sizeof(tm)); - tm.tm_year = 70; - tm.tm_mon = 0; - tm.tm_mday = 5; // not Jan 1st 1970 due to mktime 'feature' - tm.tm_hour = 0; - tm.tm_min = 0; - tm.tm_sec = 0; - tm.tm_isdst = -1; // let mktime guess - - // Note that mktime assumes that the struct tm contains local time. - // - t1 = time(&t1); // now - t0 = mktime(&tm); // origin - - // Return the difference in seconds. - // - if (( t0 != (time_t)-1 ) && ( t1 != (time_t)-1 )) - return (long)difftime(t1, t0) + (60 * 60 * 24 * 4); - - wxLogSysError(_("Failed to get the local system time")); - return -1; + wxCHECK_MSG( m_impl, false, _T("uninitialized timer") ); + + return m_impl->IsRunning(); } -// Get UTC time as seconds since 00:00:00, Jan 1st 1970 -long wxGetUTCTime() +int wxTimer::GetId() const { - struct tm tm; - struct tm *ptm; - time_t t0, t1; - - // This cannot be made static because mktime can overwrite it - // - memset(&tm, 0, sizeof(tm)); - tm.tm_year = 70; - tm.tm_mon = 0; - tm.tm_mday = 5; // not Jan 1st 1970 due to mktime 'feature' - tm.tm_hour = 0; - tm.tm_min = 0; - tm.tm_sec = 0; - tm.tm_isdst = -1; // let mktime guess - - // Note that mktime assumes that the struct tm contains local time. - // - t1 = time(&t1); // now - t0 = mktime(&tm); // origin in localtime - - if (( t0 != (time_t)-1 ) && ( t1 != (time_t)-1 )) - { - // To get t0 as GMT we convert to a struct tm with gmtime, - // and then back again. - // - ptm = gmtime(&t0); - - if (ptm) - { - memcpy(&tm, ptm, sizeof(tm)); - t0 = mktime(&tm); - - if (t0 != (time_t)-1 ) - return (long)difftime(t1, t0) + (60 * 60 * 24 * 4); - wxLogSysError(_("mktime() failed")); - } - else - { - wxLogSysError(_("gmtime() failed")); - } - } + wxCHECK_MSG( m_impl, wxID_ANY, _T("uninitialized timer") ); - wxLogError(_("Failed to get the UTC system time.")); - - return -1; + return m_impl->GetId(); } -#if wxUSE_LONGLONG - -// Get local time as milliseconds since 00:00:00, Jan 1st 1970 -wxLongLong wxGetLocalTimeMillis() +int wxTimer::GetInterval() const { - wxLongLong val = 1000l; + wxCHECK_MSG( m_impl, -1, _T("uninitialized timer") ); - // If possible, use a function which avoids conversions from - // broken-up time structures to milliseconds - -#if defined(HAVE_GETTIMEOFDAY) - struct timeval tp; - if ( wxGetTimeOfDay(&tp, (struct timezone *)NULL) != -1 ) - { - val *= tp.tv_sec; - return (val + (tp.tv_usec / 1000)); - } - else - { - wxLogError(_("wxGetTimeOfDay failed.")); - return 0; - } -#elif defined(HAVE_FTIME) - struct timeb tp; - - // ftime() is void and not int in some mingw32 headers, so don't - // test the return code (well, it shouldn't fail anyhow...) - (void)ftime(&tp); - val *= tp.time; - return (val + tp.millitm); -#else // no gettimeofday() nor ftime() - // We use wxGetLocalTime() to get the seconds since - // 00:00:00 Jan 1st 1970 and then whatever is available - // to get millisecond resolution. - // - // NOTE that this might lead to a problem if the clocks - // use different sources, so this approach should be - // avoided where possible. - - val *= wxGetLocalTime(); - -// GRG: This will go soon as all WIN32 seem to have ftime -#if defined (__WIN32__) - // If your platform/compiler needs to use two different functions - // to get ms resolution, please do NOT just shut off these warnings, - // drop me a line instead at - #warning "Possible clock skew bug in wxGetLocalTimeMillis()!" - - SYSTEMTIME st; - ::GetLocalTime(&st); - val += st.wMilliseconds; -#else // !Win32 - // If your platform/compiler does not support ms resolution please - // do NOT just shut off these warnings, drop me a line instead at - // - - #if defined(__VISUALC__) || defined (__WATCOMC__) - #pragma message("wxStopWatch will be up to second resolution!") - #elif defined(__BORLANDC__) - #pragma message "wxStopWatch will be up to second resolution!" - #else - #warning "wxStopWatch will be up to second resolution!" - #endif // compiler -#endif + return m_impl->GetInterval(); +} - return val; +bool wxTimer::IsOneShot() const +{ + wxCHECK_MSG( m_impl, false, _T("uninitialized timer") ); -#endif // time functions + return m_impl->IsOneShot(); } -#endif // wxUSE_LONGLONG +#endif // wxUSE_TIMER