don't list SetSelection() as being deprecated, it isn't

[wxWidgets.git] / src / common / timercmn.cpp

diff --git a/src/common/timercmn.cpp b/src/common/timercmn.cpp
index 67cec8530ce9e87da2d96999e197b014cfedca6e..defa3b9dd40d08d18a3a7bf6ebb384cb08dd850a 100644 (file)
--- a/src/common/timercmn.cpp
+++ b/src/common/timercmn.cpp
@@ -1,17 +1,13 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        common/timercmn.cpp
 /////////////////////////////////////////////////////////////////////////////
 // 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 <guille@iies.es> 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$
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
+// Copyright:   (c) Julian Smart

 //              (c) 1999 Guillermo Rodriguez <guille@iies.es>
 //              (c) 1999 Guillermo Rodriguez <guille@iies.es>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -22,10 +18,6 @@
 // wxWin headers
 // ----------------------------------------------------------------------------
 
 // wxWin headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "timerbase.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -33,274 +25,115 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_TIMER
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #include "wx/intl.h"
-    #include "wx/log.h"
+    #include "wx/app.h"

 #endif
 
 #include "wx/timer.h"
 #endif
 
 #include "wx/timer.h"

-#include "wx/longlong.h"
-
-// ----------------------------------------------------------------------------
-// System headers
-// ----------------------------------------------------------------------------
-
-#if defined(__WIN32__)
-    #include <windows.h>
-#endif
-
-#if defined(__WIN32__) && !defined(HAVE_FTIME)
-    #define HAVE_FTIME
-#endif
-
-#include <time.h>
-#ifndef __WXMAC__
-    #include <sys/types.h>      // for time_t
-#endif
-
-#if defined(HAVE_GETTIMEOFDAY)
-    #include <sys/time.h>
-    #include <unistd.h>
-#elif defined(HAVE_FTIME)
-    #include <sys/timeb.h>
-#endif
+#include "wx/apptrait.h"
+#include "wx/private/timer.h"

 
 // ----------------------------------------------------------------------------
 // wxWin macros
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxWin macros
 // ----------------------------------------------------------------------------
 

-#if wxUSE_GUI
-    IMPLEMENT_DYNAMIC_CLASS(wxTimerEvent, wxEvent)
-#endif // wxUSE_GUI
-
-// ----------------------------------------------------------------------------
-// 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
-
-// ----------------------------------------------------------------------------
-// prototypes
-// ----------------------------------------------------------------------------
+IMPLEMENT_DYNAMIC_CLASS(wxTimerEvent, wxEvent)

 
 

-wxLongLong wxGetLocalTimeMillis();
+wxDEFINE_EVENT(wxEVT_TIMER, wxTimerEvent);

 
 // ============================================================================
 
 // ============================================================================

-// implementation
+// wxTimerBase implementation

 // ============================================================================
 
 // ============================================================================
 

-// ----------------------------------------------------------------------------
-// wxTimerBase
-// ----------------------------------------------------------------------------
+wxTimer::~wxTimer()
+{
+    Stop();

 
 

-#if wxUSE_GUI
+    delete m_impl;
+}

 
 

-void wxTimerBase::Notify()
+void wxTimer::Init()

 {
 {

-    // 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.") );
+    wxAppTraits * const traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+    m_impl = traits ? traits->CreateTimerImpl(this) : NULL;
+    if ( !m_impl )
+    {
+        wxFAIL_MSG( _T("No timer implementation for this platform") );

 
 

-    wxTimerEvent event(m_idTimer, m_milli);
-    (void)m_owner->ProcessEvent(event);
+    }

 }
 
 }
 

-#endif // wxUSE_GUI
-
-// ----------------------------------------------------------------------------
-// wxStopWatch
-// ----------------------------------------------------------------------------
+// ============================================================================
+// 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());
+    wxCHECK_MSG( m_impl, NULL, _T("uninitialized timer") );
+
+    return m_impl->GetOwner();

 }
 
 }
 

-// ----------------------------------------------------------------------------
-// old timer functions superceded by wxStopWatch
-// ----------------------------------------------------------------------------
+bool wxTimer::Start(int milliseconds, bool oneShot)
+{
+    wxCHECK_MSG( m_impl, false, _T("uninitialized timer") );

 
 

-static wxLongLong wxStartTime = 0l;
+    return m_impl->Start(milliseconds, oneShot);
+}

 
 

-// starts the global timer
-void wxStartTimer()
+void wxTimer::Stop()

 {
 {

-    wxStartTime = wxGetLocalTimeMillis();
+    wxCHECK_RET( m_impl, _T("uninitialized timer") );
+
+    if ( m_impl->IsRunning() )
+        m_impl->Stop();

 }
 
 }
 

-// Returns elapsed time in milliseconds
-long wxGetElapsedTime(bool resetTimer)
+void wxTimer::Notify()

 {
 {

-    wxLongLong oldTime = wxStartTime;
-    wxLongLong newTime = wxGetLocalTimeMillis();
-
-    if ( resetTimer )
-        wxStartTime = newTime;
+    // 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.") );

 
 

-    return (newTime - oldTime).GetLo();
+    m_impl->SendEvent();

 }
 
 }
 

+bool wxTimer::IsRunning() const
+{
+    wxCHECK_MSG( m_impl, false, _T("uninitialized timer") );

 
 

-// ----------------------------------------------------------------------------
-// the functions to get the current time and timezone info
-// ----------------------------------------------------------------------------
+    return m_impl->IsRunning();
+}

 
 

-// Get local time as seconds since 00:00:00, Jan 1st 1970
-long wxGetLocalTime()
+int wxTimer::GetId() 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, wxID_ANY, _T("uninitialized timer") );
+
+    return m_impl->GetId();

 }
 
 }
 

-// Get UTC time as seconds since 00:00:00, Jan 1st 1970
-long wxGetUTCTime()
+int wxTimer::GetInterval() const

 {
 {

-    struct tm 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, -1, _T("uninitialized timer") );

 
 

-    wxLogError(_("Failed to get the UTC system time."));
-
-    return -1;
+    return m_impl->GetInterval();

 }
 
 }
 

-
-// Get local time as milliseconds since 00:00:00, Jan 1st 1970
-wxLongLong wxGetLocalTimeMillis()
+bool wxTimer::IsOneShot() const

 {
 {

-    wxLongLong val = 1000l;
+    wxCHECK_MSG( m_impl, false, _T("uninitialized timer") );

 
 

-    // If possible, use a functin 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
-    // 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();
-
-#if defined(__VISAGECPP__)
-    DATETIME dt;
-    ::DosGetDateTime(&dt);
-    val += (dt.hundredths*10);
-#elif defined (__WIN32__)
-#warning "Possible clock skew bug in wxStopWatch!"
-    SYSTEMTIME st;
-    ::GetLocalTime(&st);
-    val += st.wMilliseconds;
-#else
-#if !defined(__VISUALC__) && !defined(__BORLANDC__)
-#warning "wxStopWatch will be up to second resolution!"
-#endif
-#endif
+    return m_impl->IsOneShot();
+}

 
 

-    return val;
+#endif // wxUSE_TIMER

 
 

-#endif
-}